History log of /vpp/doxygen/
Revision Date Author Comments
(<<< Hide modified files)
(Show modified files >>>)
47e09273 15-Nov-2019 Dave Wallace <dwallacelf@gmail.com>

build: fix docs/doxygen targets

- Add missing dependencies
- Fix clean/wipe to remove generated files
- Fix doxygen src variable

Type: fix

Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
Change-Id: If6b2797e8af3f2e735759fab5841a0b4576ed7cc

464e5e0b 01-Nov-2019 Paul Vinciguerra <pvinci@vinciconsulting.com>

docs: fix 'make doxygen' under python3

The 'make doxygen' component has this cool vpp specific customization called siphon.
This updates the siphon component so that 'make doxygen' works with python3.

Needed-By: https://gerrit.fd.io/r/23159

Type: docs

Change-Id: Ie29f1602bf3460b637058acbb0a2f19b128a8824
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>

f16826e7 07-Aug-2019 Andrew Yourtchenko <ayourtch@gmail.com>

docs: Add link to 20.01 test framework docs

Change-Id: Ida11ed3dd70058cb618a7f9c137fde2e1e133a71
Type: docs
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>

55c68c95 29-Jul-2019 Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

docs: Small fixes and ordering

* deactivtates the TODOs on doxygen (were empty)
* This move punt.md to readthedocs (should be the new
place for dev doc ?)
* Makes Handoff queue demo plugin a child of dev doc
in doxygen

Type: fix

Change-Id: I1f0476a911b35208212af8dd608bc76160efd22a
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

138945f7 03-Jul-2019 Dave Barach <dave@barachs.net>

doxygen: improve .md file discovery

Add directories under .../src which contain .md files to
DOXY_SRC_DIRECTORIES.

Type: fix

Change-Id: If7ce833b6cb9cd5ec30a8df8e263087e276cfe97
Signed-off-by: Dave Barach <dave@barachs.net>

c87b66c8 07-Feb-2019 Neale Ranns <nranns@cisco.com>

ipsec: ipsec-tun protect

please consult the new tunnel proposal at:
https://wiki.fd.io/view/VPP/IPSec

Type: feature

Change-Id: I52857fc92ae068b85f59be08bdbea1bd5932e291
Signed-off-by: Neale Ranns <nranns@cisco.com>

1ca243be 07-May-2019 Ole Troan <ot@cisco.com>

docs: Add VPP API language documentation

Initial commit of VPP API language documentation.

Change-Id: Ied67203265319a8603086486c9031e723484c501
Signed-off-by: Ole Troan <ot@cisco.com>

29325c9b 21-May-2019 Vratko Polak <vrpolak@cisco.com>

docs: add quic subpage to user docs

+ Sort subpage list.
+ Fix copypaste error in quic doc label.

Change-Id: Id8bdb4ad0d744f9886db3631ddad0e29bbb3c938
Signed-off-by: Vratko Polak <vrpolak@cisco.com>

a7752129 06-May-2019 Benoît Ganne <bganne@cisco.com>

rdma: update MAINTAINERS and add doc

Change-Id: Ida681d299fd57eba66338444b99d2476bdb3c695
Signed-off-by: Benoît Ganne <bganne@cisco.com>

b31c0ce2 01-May-2019 Dave Wallace <dwallacelf@gmail.com>

DOCS: Add link to 19.08 test framework docs

Change-Id: Ib0c3e3376152f4ec04e3689fb9ed94a859f1022f
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>

c4bbce60 30-Apr-2019 Dave Wallace <dwallacelf@gmail.com>

DOCS: Add link to 19.04 make test documentation

Change-Id: Iffa44b6a20f8446c94f8412e937ca40273aa8f2f
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>

51cbbd22 17-Apr-2019 Dave Wallace <dwallacelf@gmail.com>

Doxygen cleanup.

- Add subpages definitions in appropriate
section (User or Dev docs) for doc files
(*.rst, *.md) that being listed at the top
level of the generated doc page.
- Generate and add API list to RELEASE doc.
- Fix list_api_changes script to use HEAD
as the endtag so it doesn't need to be
changed every release.

Change-Id: Iace7b6433359c6b96869cb1db01facbbcb0ac1e6
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
(cherry picked from commit 11ee93f6abfaddf5bbd56cf0858c0c6ea0384b65)

696d7608 21-Jan-2019 Andrew Yourtchenko <ayourtch@gmail.com>

Update to doxygen documentation for release 19.01

Change-Id: Id19cefc24d391f0437a0355f5328505ec21aa58a
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
(cherry picked from commit 44f14358cfe37a750f4541e5919b0c7877b6d46e)

b4515b4b 19-Nov-2018 Matus Fabian <matfabia@cisco.com>

Add RFC5424 syslog protocol support (VPP-1139)

Syslog protocol logging transport event messages across network over UDP
protocol based on RFC5426.

Change-Id: Ica74b40bcc2e6d0fbd41e9bf78e76395fbabab3c
Signed-off-by: Matus Fabian <matfabia@cisco.com>

b99de836 17-Oct-2018 Marco Varlese <marco.varlese@suse.com>

Update to doxygen documentation for release 18.10

Change-Id: Id8eebd59bad27ac3cc46bf993a5ca1d8410bf84c
Signed-off-by: Marco Varlese <marco.varlese@suse.com>
(cherry picked from commit 44c6ca6038776787671e78e3dae78e812c72429e)

e7a9b3d2 02-Aug-2018 Ole Troan <ot@cisco.com>

API: Remove legacy vlibsocket code.

The API implementation now supports Unix domain sockets.
The vlibsocket code has not been included in builds for
a long time and is superfluous.

Change-Id: I67a773d0e86e2318eacecf33f82d075553146ee9
Signed-off-by: Ole Troan <ot@cisco.com>

404d85ac 30-Apr-2018 Chris Luke <chrisy@flirble.org>

Add reference to 18.04 test framework documentation

Change-Id: I0f24e0f0fde0568161edf52f40c5b83877ed7130
Signed-off-by: Chris Luke <chrisy@flirble.org>

546ad855 04-Apr-2018 Chris Luke <chrisy@flirble.org>

Doc updates prior to branch

Change-Id: Ibcffee7d20dbb79720199bcd82d2353f39d5544f
Signed-off-by: Chris Luke <chrisy@flirble.org>

f2d0611e 25-Jan-2018 Dave Wallace <dwallacelf@gmail.com>

Add link to 18.01 test framework documentation.

Change-Id: I030602391ea3b612ac9a6780399cc30b427cc3a5
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
(cherry picked from commit 92b15bcea4c6c5e62415a8207463eb9a897630c6)

28cf3b7d 15-Jan-2018 Billy McFall <bmcfall@redhat.com>

VPP-899: Run VPP under SELinux

Add an SELinux profile such that VPP can run under SELinux on RPM based
platforms. The SELinux Policy is currently only implemented for RPM
packages, specifically, Fedora, CentOS and RHEL. Doxygen User
Documentation has been included (selinux_doc.md). Once some discussion
on file locations has completed (see vpp-devlist), updates to the Debug
CLI documentation will also need to be updated.

Additional changes:
Patch Set 2:
- Rework selinux_doc.md such that each line is only 80 characters
instead of each sentence on a line. Made additonal minor chnages
to the text.
- Update vHost Debug CLI documentation to reflex new socket location.
Cleaned up some text from when I originally wrote it, to better
reflex proper use.
- Update exec Debug CLI documentation to be more inline with suggested
helptext, added text regarding recommended script file location.
- For Debian builds, create the /var/log/vpp/ directory. I don't use
Debian very much, so please pay extra attention to
build-data/platforms.mk and build-root/deb/debian/.gitignore.
- Per discussion on VPP call, changed the default log location to
/var/log/vpp/vpp.log.
- Changed the socket location for vHost in AutoConfig to
/var/run/vpp/.
Patch Set 3:
- Update selinux_doc.md based on comments.

Change-Id: I400520dc33f1ca51012d09ef8fe5a7b7b96c631e
Signed-off-by: Billy McFall <bmcfall@redhat.com>

6cd396ce 23-Jan-2018 Dave Wallace <dwallacelf@gmail.com>

docs: Clean up TOC

Change-Id: I5415c002a431d84372f56d4a77dc2aabd6ef55f7
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
(cherry picked from commit 1eb970d16028e9a987c1dd2bfe217d1313262b81)

891f0a1c 11-Dec-2017 Florin Coras <fcoras@cisco.com>

apps: refactor uri and update build infra

Change-Id: Ifa9966a27586a1a65038d069cf4a1e6e21a72d45
Signed-off-by: Florin Coras <fcoras@cisco.com>

0b0421d7 03-Nov-2017 Chris Luke <chrisy@flirble.org>

Add C++ files to Doxygen

Change-Id: Iab943988d1c714fe315e1dd13bd5d21f6bebdca1
Signed-off-by: Chris Luke <chrisy@flirble.org>

64ebb5ff 27-Sep-2017 Chris Luke <chrisy@flirble.org>

General documentation updates

- We now have several developer-focused docs, so create an index page
for them.
- Rework several docs to fit into the index structure.
- Experiment with code highlighting; tweak the CSS slightly to make
it slightly nicer to look at.

Change-Id: I4185a18f84fa0764745ca7a3148276064a3155c6
Signed-off-by: Chris Luke <chrisy@flirble.org>

905c14af 25-Sep-2017 Dave Barach <dave@barachs.net>

Add binary API documentation

Change-Id: Id1a5da12b13d87bacfa81094f471b95db40c39be
Signed-off-by: Dave Barach <dave@barachs.net>

29059b49 22-Jun-2017 Matus Fabian <matfabia@cisco.com>

NAT64: documentation

added CLI command documentation
added NAT64 user documentation page

Change-Id: I3df400013800fe16351e02db7762ee3f92b195ff
Signed-off-by: Matus Fabian <matfabia@cisco.com>

583dc8d3 08-Jun-2017 Ray Kinsella <ray.kinsella@intel.com>

Sample plugin: Add sample plugin documentation

Added some user documentation to sample plugin.

Change-Id: I518910f80499307e8fcac8dcef7baaeab5ea8e35
Signed-off-by: Ray Kinsella <ray.kinsella@intel.com>

5c749734 13-Mar-2017 Ole Troan <ot@cisco.com>

Flowprobe: Stateful flows and IPv6, L4 recording

Change-Id: I67839281623721bf42f0a918a53356143d9dc78a
Signed-off-by: Ole Troan <ot@cisco.com>
Signed-off-by: Pavel Kotucek <pkotucek@cisco.com>
Signed-off-by: Ole Troan <ot@cisco.com>

3335693c 10-May-2017 Chris Luke <chrisy@flirble.org>

doxygen: Fix some paths

- Add missing src dir.
- Exclude 'src/examples' from siphon processing so that example cli commands
don't end up in user documentation.

Change-Id: I46a6ad759fa8220d305b007a9506956365fc79bd
Signed-off-by: Chris Luke <chrisy@flirble.org>

5d73eecd 24-Apr-2017 Pablo Camarillo <pcamaril@cisco.com>

First commit SR MPLS

Change-Id: I961685a2a0e4c314049444c64eb6ccf877c278dd
Signed-off-by: Pablo Camarillo <pcamaril@cisco.com>

4521afa9 16-Mar-2017 Pablo Camarillo <pcamaril@cisco.com>

Bugfixing and documentation for SRv6

- Fixed three coverity issues
- Linked SRv6 docs
- Moved sample plugin to examples folder
- Fixed bug with hash. Now everything is using mhash. Potentially in the future we want to do bihash.

Change-Id: Ie03a13c8fecb1e315e67d0596cbd23220779aaf2
Signed-off-by: Pablo Camarillo <pcamaril@cisco.com>

c8c5335e 17-Feb-2017 Dave Wallace <dwallacelf@gmail.com>

Add ref to test framework docs in doxygen output.

Change-Id: If3081c4a9dde00cd522d1fc5a7daa9b1849684bf
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>

85bb9172 02-Feb-2017 Marco Varlese <marco.varlese@suse.com>

Added support for openSUSE

Change-Id: I64a0eeaa066adb70dfaeb33641d0336ddac18cf0
Signed-off-by: Marco Varlese <marco.varlese@suse.com>

1c5ee872 10-Jan-2017 Damjan Marion <damarion@cisco.com>

Remove vcgn plugin

Change-Id: I79f18ec386dedd91a8dcea2ca5726208b7b3c67c
Signed-off-by: Damjan Marion <damarion@cisco.com>

6bbf83a0 10-Jan-2017 Damjan Marion <damarion@cisco.com>

Revert "vppctl: bash completion for vppctl commands"

This patch is causing build failures

This reverts commit d995c757f05f78aa759b0a65c0a7e38088e690a9.

Change-Id: I0c8d5a4208135d77aaa3a6a470d26140f7b74733
Signed-off-by: Damjan Marion <damarion@cisco.com>

d995c757 29-Nov-2016 Padraig Connolly <padraig.connolly@intel.com>

vppctl: bash completion for vppctl commands

Added bash completion that will include all commands from build time
*Script takes list of commands generated by doxygen-siphon-list
*Configured doxygen-siphon makefile to generate just cli commands
*List of cli commands put in /usr/share/vpp
*Stopped siphon using doxygen bootstrap, uses main bootstrap instead
*Added rpm/deb check for installation of packages, separate from bootstrap
*NOTE: Once you have installed the vpp .deb/.rpm package you will have to
restart bash

Change-Id: Ie503e80d5177481f6e7dbe59378f2e0d76f29152
Signed-off-by: Padraig Connolly <padraig.connolly@intel.com>

cb034b9b 28-Dec-2016 Damjan Marion <damarion@cisco.com>

Move java,lua api and remaining plugins to src/

Change-Id: I1c3b87e886603678368428ae56a6bd3327cbc90d
Signed-off-by: Damjan Marion <damarion@cisco.com>

fdc62abd 28-Dec-2016 Chris Luke <chrisy@flirble.org>

Repair Doxygen build infrastructure

After Gerrit 4430 much of the documentation failed to build, but
silently so it was easily missed; equally missing that several
paths have been missing for a while.

- Correct paths after directory tree changes.
- Doxygen now bails when input paths don't exist.
- Fix up some of the less deranged entries in the documentation index.
- Exclude the LUA tree, its documentation is a mess.

Change-Id: I35e6b433feee5e05bca772d93aa1635c724db734
Signed-off-by: Chris Luke <chrisy@flirble.org>

c3f92adf 05-Oct-2016 Chris Luke <chrisy@flirble.org>

Add support for using documentation siphons in multiple ways

Experiental support for generating multiple output formats from the
same siphoned data.

Adds a contrived example to generate a plain list of all CLI commands
(the "itemlist" format).

Eventually we can consider moving the tempate procesisng into the
Output class as well as a way to override how the data is traversed
(ordered).

Change-Id: I77629a74a8fa0c7e583993469dc50491f72f13e7
Signed-off-by: Chris Luke <chrisy@flirble.org>

a10f62b1 25-Nov-2016 Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>

dpdk: add ipsec cryptodev support

DPDK Cryptodev support and related IPsec ESP nodes using DPDK Cryptodev APIs.

When DPDK Cryptodev support is enabled, the node graph is modified by adding
and replacing some of the nodes.

The following nodes are replaced:
* esp-encrypt -> dpdk-esp-encrypt
* esp-decrypt -> dpdk-esp-decrypt

The following nodes are added:
* dpdk-crypto-input : polling input node
* dpdk-esp-encrypt-post : internal node
* dpdk-esp-decrypt-post : internal node

Change-Id: I6dca9a890abaf4fb2a4fffce3fd08ac013e4d701
Signed-off-by: Zhang, Roy Fan <roy.fan.zhang@intel.com>
Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>

ad41b351 07-Oct-2016 Dave Barach <dave@barachs.net>

Per-packet IPFIX record generation plugin

Change-Id: Ia790aa018e70d67ed343e3e466d1b33b22560fc0
Signed-off-by: Dave Barach <dave@barachs.net>

d8279986 04-Oct-2016 Chris Luke <chrisy@flirble.org>

Minor tweaks to hqos doc

- correct formatting errors
- add to user_doc tree
- unix line endings, not windows(!)

Change-Id: I9aa5511c398fc33ecb25fb33ae64c8e666c56dd8
Signed-off-by: Chris Luke <chrisy@flirble.org>

af405f77 26-Sep-2016 Chris Luke <chrisy@flirble.org>

Fix missing output in generated CLI/config

The templates were looking for the name of the CLI_COMMAND
and CONFIG_FUNCTION structures in the srong place.

Change-Id: I709d6716216173ba6a7ed41a260728238f96d2db
Signed-off-by: Chris Luke <chrisy@flirble.org>

36d25063 23-Sep-2016 Chris Luke <chrisy@flirble.org>

Enable doc building on MacOS

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>

90f52bf9 12-Sep-2016 Chris Luke <chrisy@flirble.org>

Refactor pre-Doxy siphon scripts; VPP-396

- 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>

60537f3d 21-Sep-2016 Chris Luke <chrisy@flirble.org>

Move doxytags file to html output directory

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>

f3045526 21-Sep-2016 Chris Luke <chrisy@flirble.org>

Copy the 16.09 release notes to master

- 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>

5ccbaa97 14-Sep-2016 Chris Luke <chrisy@flirble.org>

Add structure to some of the documentation; VPP-223

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>

35425140 10-Sep-2016 Chris Luke <chrisy@flirble.org>

Check for zero-sized Graphvix config file on Ubuntu; VPP-396

- 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>

c87fa6de 09-Sep-2016 Chris Luke <chrisy@flirble.org>

On Ubuntu check for graphviz system config

- 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>

3b480933 07-Sep-2016 Chris Luke <chrisy@flirble.org>

VPP-346 Improve Doxygen include path mechanism

- 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>

d4024f58 06-Sep-2016 Chris Luke <chrisy@flirble.org>

VPP-346 More VPP doc fixes

- 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>

ee4743ad 01-Sep-2016 Chris Luke <chrisy@flirble.org>

VPP-221 Improve doxygen dependency check

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>

16bcf7d8 01-Sep-2016 Chris Luke <chrisy@flirble.org>

VPP-346 A swathe of doc fixes

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>

e0d802bc 31-Aug-2016 Chris Luke <chrisy@flirble.org>

VPP-221 Loosen Doxygen CLI command struct parser

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>

54ccf226 25-Jul-2016 Chris Luke <chrisy@flirble.org>

VPP-221 CLI auto-documentation infrastructure

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>

f8a554f7 06-Aug-2016 Keith Burns (alagalah) <alagalah@gmail.com>

Add DPDK definition to DOXYGEN

Change-Id: I04e8663b49b5f706940b7aada0a7c2cae913a82b
Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>

4aa76c1c 25-Jul-2016 Chris Luke <chrisy@flirble.org>

Fix missing include dirs in doxygen

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>

9770e20a 06-Jul-2016 Dave Barach <dave@barachs.net>

Add some doxygen tags

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>

aa761e12 14-May-2016 Chris Luke <chrisy@flirble.org>

VPP-57 Add missing license headers in doc files

Change-Id: Icd1f8952f66d3cee027c59f3148c67f1839de306
Signed-off-by: Chris Luke <chrisy@flirble.org>

75a37b37 14-May-2016 Chris Luke <chrisy@flirble.org>

VPP-62 Add a doxy filter to enable vpe.api doc

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>

b5850970 03-May-2016 Chris Luke <chrisy@flirble.org>

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>