summaryrefslogtreecommitdiffstats
path: root/doxygen
AgeCommit message (Collapse)AuthorFilesLines
2016-09-23Enable doc building on MacOSChris Luke1-1/+25
Simple tweak to the Makefiles to allow "make doxygen" to work natively on Macs - assuming the appropriate things have been installed first, which it tests for. Change-Id: I1a3e72759d533270a0512de38595c3bc3f71dee0 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-21Refactor pre-Doxy siphon scripts; VPP-396Chris Luke24-657/+1486
- Modularize the code to make the Siphon process easier to maintain. - Move much of the output rendering into Jinja2 templates. - Add syscfg siphon type for startup config documentation. - Add sample syscfg documentation. - Add clicfg and syscfg preamble docs, adapted from their wiki pages. - Fix sorting of CLI items across multiple directories. Change-Id: Ib8288fe005adfea68ceed75a38ff8eba25d3cc79 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-21Move doxytags file to html output directoryChris Luke1-1/+1
So that downstream projects can make use of the generated Doxygen tags file, move it into the html directory that is transferred to Nexus. Change-Id: I04dc4777c9ea62f429f783f66ef4e2ecb2923131 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-21Copy the 16.09 release notes to masterChris Luke1-0/+1
- Copy the 16.09 release notes to master - Add some notes for 16.06 (from the press release) - Add some structure around notes for each release - Add skeleton for next release Change-Id: Id5a5d8bf02fce1bbaed303e6c6e4f8908c7e7d75 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-20Add structure to some of the documentation; VPP-223Chris Luke2-1/+15
Moves the random .md files, when rendered by Doxygen, into a config examples tree. We may later flesh this out into a more complete user documentation section. Change-Id: If423b82f1047f1c84f90876a786313054b5f7c77 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-09Check for zero-sized Graphvix config file on Ubuntu; VPP-396Chris Luke1-1/+2
- The previous change only accounted for a missing Graphviz config file; apparently it can be zero-sized too. Change-Id: Ic6957d10cdc7cb7b9da72d2b2a0f8913100870c5 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-09On Ubuntu check for graphviz system configChris Luke1-0/+3
- Sometimes it seems Ubuntu doesn't always set up the Graphviz handler config. If it's missing, generate it. Change-Id: I2c1e566817de8415f8b360c6f967cd76307a2a52 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-07VPP-346 Improve Doxygen include path mechanismChris Luke2-23/+55
- If present, include the directories where API header files are generated into. - Improve extraction of include paths from CPP - Generalize the file/directory exclusion This reduces some of the "warning" chatter from Doxygen. Change-Id: I7ac02bff1639fe63f11263176020b0f040255017 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-06VPP-346 More VPP doc fixesChris Luke3-15/+48
- Fix issue in Doxy dependency check when nothing needs to be installed. 'set -e' and plain '[]' logic don't mix well. - Fix Makefile snafu when building Doxy output for a single file. - Include only one of vnet/vnet/buffer.c/dpdk_buffer.c in docs depending on DPDKness. This could do with some improvement in future, eg to properly align the pre-doxy steps with what Doxy does. - Fix rendering of 'inline' tag in Doxygen by having it interpret always_inline as "inline static". - Bunch of duplicate CLI command structure names that confused docs and may one day have caused debugging issues. - Several other Doxygen syntax issues fixed, like documenting non-existant parameters (usually just the wrong parameter name, typos, etc) Change-Id: Ia8cca545e5de9f8750602bffa3c4548acc8971aa Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-02VPP-221 Improve doxygen dependency checkChris Luke1-1/+5
Only try to install packages if they're not installed. Saves a trip through sudo which is useful when you have a non-privileged account generating the docs. Change-Id: I3709aceb15516a45ea2f9510d91c6d2e42c8c349 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-01VPP-346 A swathe of doc fixesChris Luke4-16/+94
Fixes various Doxygen warnings and other structural defects. Note: This does not attempt to improve the content of the documentation; only to improve the syntax and structure of it and in some cases the consistency. Change-Id: Ib1915f33edbdbc4558c85565de80dce323193906 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-08-31VPP-221 Loosen Doxygen CLI command struct parserChris Luke2-1/+2
Make the struct parser slighty slightly more accomodating of whitespace in places it has no business being. Also add missing OS_ID thing to Doxygen makefile. Change-Id: Id3d198fd926f7a6c2ed40bc2d08907aad5d5ac33 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-08-31VPP-221 CLI auto-documentation infrastructureChris Luke6-5/+793
As a step before Doxygen, extract CLI-related struct initializers from the code and parse that into a summary of the CLI commands available with the provided help text, such as it is. At the moment this only renders this into an indexed Markdown file that Doxygen then picks up but later we can use this information to enrich the existing VLIB_CLI_COMMAND macro documentor as well as provide runtime documentation to VPP that is stored on disk outside the binary image. Additionally support a comment block immediately prior to VLIB_CLI_COMMAND CLI command definitions in the form /*? ... ?*/ that can be used to include long-form documentation without having it compiled into VPP. Examples of documenting CLI commands can be found in vlib/vlib/unix/cli.c which, whilst not perfect, should provide a starting point. Screen captures of sample output can be seen at https://chrisy.flirble.org/vpp/doxy-cli-example.png and https://chrisy.flirble.org/vpp/doxy-cli-index.png . Next, shift the Doxygen root makefile targets to their own Makefile. The primary reason for this is that the siphon targets do dependency tracking which means it needs to generate those dependencies whenever make is run; that is pointless if we're not going to generate any documentation. This includes the package dependencies since they since they sometimes unnecessarily interfere with the code build in some cases at the moment; later we will look to building a Python venv to host the Python modules we use. One final remark: In future we may consider deprecating .long_help in the VLIB_CLI_COMMAND structure entirely but add perhaps .usage_help. .short_help would be reserved for a summary of the command function and .usage_help provide the syntax of that command. These changes would provide great semantic value to the automaticly generated CLI documentation. I could also see having .long_help replaced by a mechanism that reads it from disk at runtime with a rudimentary Markdown/Doxygen filter so that we can use the same text that is used in the published documentation. Change-Id: I80d6fe349b47dce649fa77d21ffec0ddb45c7bbf Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-08-06Add DPDK definition to DOXYGENKeith Burns (alagalah)1-2/+3
Change-Id: I04e8663b49b5f706940b7aada0a7c2cae913a82b Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>
2016-07-26Fix missing include dirs in doxygenChris Luke1-1/+1
Also allow a developer to alter the directories scanned at runtime to facilitate shorter run-times when writing documentation. Change-Id: I2a09519661a3abe1fbc0cfc294000934852af951 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-07-07Add some doxygen tagsDave Barach1-0/+1
Also add an index of node names Change-Id: Id65c2e607976d8bad73deb738035a471be077196 Signed-off-by: Dave Barach <dave@barachs.net> Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-05-16VPP-57 Add missing license headers in doc filesChris Luke1-0/+22
Change-Id: Icd1f8952f66d3cee027c59f3148c67f1839de306 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-05-15VPP-62 Add a doxy filter to enable vpe.api docChris Luke3-5/+67
This makes Doxygen think the API definitions are structs which is close enough to be able to document the API methods. It also has logic to create an indexed API page but that's disabled for now because it duplicates the "brief" text twice in the struct doc. Fixes a minor line numbering issue in filter_c.py. Change-Id: If380160b73e7c10d999b35a76f55d0e27cbc91cc Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-05-13VPP-57 Add Doxygen to VPPChris Luke6-0/+2717
- 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>