aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/dpdk/ipsec/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/ipsec/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/ipsec/dir.dox')
-rw-r--r--src/plugins/dpdk/ipsec/dir.dox13
1 files changed, 11 insertions, 2 deletions
diff --git a/src/plugins/dpdk/ipsec/dir.dox b/src/plugins/dpdk/ipsec/dir.dox
index ffebfc4d..05504541 100644
--- a/src/plugins/dpdk/ipsec/dir.dox
+++ b/src/plugins/dpdk/ipsec/dir.dox
@@ -1,5 +1,6 @@
/*
* Copyright (c) 2016 Intel 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:
@@ -12,7 +13,15 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+/* Doxygen directory documentation */
+
/**
- @dir vnet/vnet/devices/dpdk/ipsec
- @brief IPSec ESP encrypt/decrypt using DPDK Cryptodev API
+@dir src/plugins/dpdk/ipsec
+@brief IPSec ESP encrypt/decrypt using DPDK Cryptodev API.
+
+This directory contains the source code for the DPDK Crypto abstraction layer.
+
*/
+/*? %%clicmd:group_label DPDK Crypto %% ?*/
+/*? %%syscfg:group_label DPDK Crypto %% ?*/