aboutsummaryrefslogtreecommitdiffstats
path: root/vlib/vlib/vlib_process_doc.h
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2016-09-07 15:01:31 -0400
committerChris Luke <chrisy@flirble.org>2016-09-07 15:17:14 -0400
commitfcaa2f101083666f83fed71f28008edd2217a364 (patch)
tree1b3a752169e7698865b96ff814136bb066006db8 /vlib/vlib/vlib_process_doc.h
parent78e0e3af7072cd8977c73c41863776be10d54155 (diff)
VPP-223 Various documentation fixes.
[Note: This is an amalgamation of two patches on master with only the parts relevant to stable included. See 16bcf7d8 and d4024f58] This is a cleanup of some obvious syntactic issues with Doxygen tags in the documentation. It is not an attempt to improve the documentation itself. Change-Id: I278ad91fe980243778f84560c5e4b84a9423dc09 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.h6
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