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 /vlib/example | |
| 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 'vlib/example')
| -rw-r--r-- | vlib/example/dir.dox | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/vlib/example/dir.dox b/vlib/example/dir.dox new file mode 100644 index 00000000000..8dc0fee7749 --- /dev/null +++ b/vlib/example/dir.dox @@ -0,0 +1,6 @@ +/* Doxygen directory documentation */ +/** +@dir +@brief Someone please fix this description +@todo This directory needs a description. +*/ |