Code Review / vpp.git / commit
? search:
summary | shortlog | log | commit | commitdiff | review | tree
(parent: 94b1442) | patch
VPP-57 Add Doxygen to VPP 79/979/13
authorChris Luke <chrisy@flirble.org>
Tue, 3 May 2016 20:34:59 +0000 (16:34 -0400)
committerDave Barach <openvpp@barachs.net>
Fri, 13 May 2016 17:23:36 +0000 (17:23 +0000)
commitb585097048884e063ac25aecc26a6802ee3faa4d
tree81ea056965937bfcb373f28b83ca51c188ddc4a6tree | snapshot
parent94b1442a6731bb879797c016a8febaec2f2ae7c9commit | 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>
19 files changed:
.gitignore diff | blob | history
Makefile diff | blob | history
README.md [new file with mode: 0644] blob
doxygen/assets/doxy-vpp.css [new file with mode: 0644] blob
doxygen/assets/logo_fdio.png [new file with mode: 0644] blob
doxygen/dir.dox.sample [new file with mode: 0644] blob
doxygen/doxygen.cfg [new file with mode: 0644] blob
doxygen/filter_c.py [new file with mode: 0755] blob
doxygen/layout.xml [new file with mode: 0644] blob
svm/dir.dox [new file with mode: 0644] blob
vlib/dir.dox [new file with mode: 0644] blob
vlib/example/dir.dox [new file with mode: 0644] blob
vlib/vlib/dir.dox [new file with mode: 0644] blob
vlib/vlib/unix/cli.c diff | blob | history
vpp/vnet/main.c diff | blob | history
vppinfra/dir.dox [new file with mode: 0644] blob
vppinfra/tools/dir.dox [new file with mode: 0644] blob
vppinfra/vppinfra/dir.dox [new file with mode: 0644] blob
vppinfra/vppinfra/vec.h diff | blob | history
Vector Packet Processing