aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/dpdk/device/dir.dox
diff options
context:
space:
mode:
authorBilly McFall <bmcfall@redhat.com>2017-03-10 14:49:15 -0500
committerDave Barach <openvpp@barachs.net>2017-03-13 14:36:35 +0000
commitdfde53ae553f9d4c54882fb55a832cb0614834ea (patch)
treef2463f10023adc11803b1ea372399ff47b6e7629 /src/plugins/dpdk/device/dir.dox
parent1904c47d5f79f8e9dcc6c9ae2043e7d6be8bd6d8 (diff)
VPP-279: Document changes for vnet/vnet/devices
Add doxygen documentation for DPDK crypto CLI command. The move of DPDK to a plugin invalidated the local dir.dox. So moved dpdk/dir.dox to dpdk/device/dir.dox to fix. Change-Id: I229e2921c4b0cdd380021adb520cd2089a376afa Signed-off-by: Billy McFall <bmcfall@redhat.com>
Diffstat (limited to 'src/plugins/dpdk/device/dir.dox')
-rw-r--r--src/plugins/dpdk/device/dir.dox27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/plugins/dpdk/device/dir.dox b/src/plugins/dpdk/device/dir.dox
new file mode 100644
index 00000000..43e36753
--- /dev/null
+++ b/src/plugins/dpdk/device/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 DPDK Abstraction Layer.
+
+This directory contains the source code for the DPDK abstraction layer.
+
+*/
+/*? %%clicmd:group_label DPDK and pcap tx %% ?*/
+/*? %%syscfg:group_label DPDK and pcap tx %% ?*/