diff options
| author |   Chris Luke <chrisy@flirble.org> | 2016-05-03 16:34:59 -0400 |
|---|---|---|
| committer |   Dave Barach <openvpp@barachs.net> | 2016-05-13 17:23:36 +0000 |
| commit | b585097048884e063ac25aecc26a6802ee3faa4d (patch) | |
| tree | 81ea056965937bfcb373f28b83ca51c188ddc4a6 /vppinfra | |
| parent | 94b1442a6731bb879797c016a8febaec2f2ae7c9 (diff) | |
VPP-57 Add Doxygen to VPP
- Configures Doxygen.
- Adds a source filter to do magic on our use of the preprocessor to do
constructor stuff to make Doxygen grok it better.
- Adds a convenience helper to the root Makefile.
- Adds a README.md to the root directory (and which Doxygem uses as its
"mainpage".
- Add several other documentative files.
- Currently using SVG for call graphs, though this may have a
load-time performance impact in browsers.
Change-Id: I25fc6fb5bf634319dcb36a7f0e32031921c125ac
Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'vppinfra')
| -rw-r--r-- | vppinfra/dir.dox | 3 | ||||
| -rw-r--r-- | vppinfra/tools/dir.dox | 3 | ||||
| -rw-r--r-- | vppinfra/vppinfra/dir.dox | 3 | ||||
| -rw-r--r-- | vppinfra/vppinfra/vec.h | 4 |
4 files changed, 11 insertions, 2 deletions
diff --git a/vppinfra/dir.dox b/vppinfra/dir.dox new file mode 100644 index 00000000000..de59898cee5 --- /dev/null +++ b/vppinfra/dir.dox @@ -0,0 +1,3 @@ +/** @dir + * @brief VPP infrastructure library and tools. + */ diff --git a/vppinfra/tools/dir.dox b/vppinfra/tools/dir.dox new file mode 100644 index 00000000000..1a641f9b89e --- /dev/null +++ b/vppinfra/tools/dir.dox @@ -0,0 +1,3 @@ +/** @dir + * @brief VPP instrastructure tools. + */ diff --git a/vppinfra/vppinfra/dir.dox b/vppinfra/vppinfra/dir.dox new file mode 100644 index 00000000000..b1bb90cd982 --- /dev/null +++ b/vppinfra/vppinfra/dir.dox @@ -0,0 +1,3 @@ +/** @dir + * @brief VPP infrastructure library source. + */ diff --git a/vppinfra/vppinfra/vec.h b/vppinfra/vppinfra/vec.h index 0c3237d3852..7017358f9b2 100644 --- a/vppinfra/vppinfra/vec.h +++ b/vppinfra/vppinfra/vec.h @@ -916,7 +916,7 @@ do { \ } while (0) -/** \brief . +/** \brief Test whether a vector is a NULL terminated c-string. @param V (possibly NULL) pointer to a vector. @return BOOLEAN indicating if the vector c-string is null terminated. @@ -924,7 +924,7 @@ do { \ #define vec_c_string_is_terminated(V) \ (((V) != 0) && (vec_len (V) != 0) && ((V)[vec_len ((V)) - 1] == 0)) -/** \brief (If necessary) Null terminate a vector containing a c-string. +/** \brief (If necessary) NULL terminate a vector containing a c-string. @param V (possibly NULL) pointer to a vector. @return V (value-result macro parameter) |