summaryrefslogtreecommitdiffstats
path: root/src/vnet/devices/netmap/dir.dox
diff options
context:
space:
mode:
authorBilly McFall <bmcfall@redhat.com>2017-01-11 08:44:52 -0500
committerDamjan Marion <dmarion.lists@gmail.com>2017-01-14 09:42:45 +0000
commit2d0b6e380be3acec05f4acea9e4f1b9bb730ee88 (patch)
tree074d6a55c26b6fc76d0b6a6601f37fdc06251996 /src/vnet/devices/netmap/dir.dox
parent5a3a6c09f58a28fee1a673475e1c25b3aea31f60 (diff)
VPP-279: Document changes for vnet/vnet/devices
Add doxygen documentation for netmap CLI commands. Change-Id: I8d3ce12b1cfa5af30ddcd31cb476ca4652cfc2f3 Signed-off-by: Billy McFall <bmcfall@redhat.com>
Diffstat (limited to 'src/vnet/devices/netmap/dir.dox')
-rw-r--r--src/vnet/devices/netmap/dir.dox27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/vnet/devices/netmap/dir.dox b/src/vnet/devices/netmap/dir.dox
new file mode 100644
index 00000000000..7ddbf947c29
--- /dev/null
+++ b/src/vnet/devices/netmap/dir.dox
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* Doxygen directory documentation */
+
+/**
+@dir
+@brief netmap Interface Implementation.
+
+This directory contains the source code for the netmap driver.
+
+*/
+/*? %%clicmd:group_label netmap %% ?*/
+/*? %%syscfg:group_label netmap %% ?*/