diff options
author | 2016-09-06 09:32:36 -0400 | |
---|---|---|
committer | 2016-09-06 20:35:28 +0000 | |
commit | d4024f586216a6bf4e2dfb667df8149b7f95b5c6 (patch) | |
tree | b8150f25da5e7b79ce119f8996fda1bd037dc0df /vlib/vlib/vlib_process_doc.h | |
parent | 7394b5b06b6549b5ff7fe3f1103c269ae966f584 (diff) |
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>
Diffstat (limited to 'vlib/vlib/vlib_process_doc.h')
-rw-r--r-- | vlib/vlib/vlib_process_doc.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/vlib/vlib/vlib_process_doc.h b/vlib/vlib/vlib_process_doc.h index 43a51b57efa..a47c5e4bbe4 100644 --- a/vlib/vlib/vlib_process_doc.h +++ b/vlib/vlib/vlib_process_doc.h @@ -57,8 +57,8 @@ Here's an example: - <pre> - #define EXAMPLE_POLL_PERIOD 10.0 + <code><pre> + \#define EXAMPLE_POLL_PERIOD 10.0 static uword example_process (vlib_main_t * vm, vlib_node_runtime_t * rt, @@ -120,7 +120,7 @@ .type = VLIB_NODE_TYPE_PROCESS, .name = "example-process", }; - </pre> + </pre></code> In this example, the VLIB process node waits for an event to occur, or for 10 seconds to elapse. The code demuxes on the event |