ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

VPP-57 Add Doxygen to VPP

Browse Source 
- 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>
This commit is contained in:
Chris Luke
2016-05-03 16:34:59 -04:00
committed by Dave Barach
parent 94b1442a67
commit b585097048
19 changed files with 2996 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
vlib/example/dir.dox Normal file
View File

@ -0,0 +1,6 @@
/* Doxygen directory documentation */
/**
@dir
@brief Someone please fix this description
@todo This directory needs a description.
*/