From b585097048884e063ac25aecc26a6802ee3faa4d Mon Sep 17 00:00:00 2001 From: Chris Luke Date: Tue, 3 May 2016 16:34:59 -0400 Subject: 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 --- vlib/example/dir.dox | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 vlib/example/dir.dox (limited to 'vlib/example') 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. +*/ -- cgit 1.2.3-korg