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>
vpp-api \
plugins
+DOXY_INCLUDE_PATH = $(shell set -e; cd $(WS_ROOT); for item in $(DOXY_INPUT); do find $$item -type d; done)
+DOXY_INCLUDE_PATH += $(shell set -e; cpp -v </dev/null 2>&1 | grep -A 1000 '\#include' | awk '/^ /{print $$1}')
+
# Target directory for doxygen output
DOXY_OUTPUT ?= $(BR)/docs
ROOT="$(WS_ROOT)" \
BUILD_ROOT="$(BR)" \
INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT)) $(EXTRA_DOXY_INPUT)" \
+ INCLUDE_PATH="$(DOXY_INCLUDE_PATH)" \
HTML=YES \
VERSION="`git describe --tags --dirty`" \
doxygen $(DOXY_DIR)/doxygen.cfg
ALIASES += "node=@xrefitem nodes \"Node Identifier\" \"Node Identifiers\" @c "
## Formatting for CLI commands and output
+ALIASES += "cli{1}=<code><pre>\1</code></pre>"
ALIASES += "clistart=<code><pre>"
ALIASES += "cliend=</pre></code>"
FILTER_PATTERNS = \
*.c=$(ROOT)/doxygen/filter_c.py \
+ *.h=$(ROOT)/doxygen/filter_h.py \
*.api=$(ROOT)/doxygen/filter_api.py
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
-INCLUDE_PATH = $(INPUT)
+INCLUDE_PATH = $(INCLUDE_PATH)
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
sys.exit(1)
replace_patterns = [
- # Search for VLIB_CLI_COMMAND, extract its parameter and add a docblock for it
- ( re.compile("(?P<m>VLIB_CLI_COMMAND)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"), r"/** @brief (@em constructor) \g<m> (\g<name>) */ vlib_cli_command_t \g<name>"),
-
- # Search for VLIB_REGISTER_NODE, extract its parameter and add a docblock for it
- ( re.compile("(?P<m>VLIB_REGISTER_NODE)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"), r"/** @brief (@em constructor) \g<m> (\g<name>) */ vlib_node_registration_t \g<name>"),
+ # Search for VLIB_CLI_COMMAND, extract its parameters and add a docblock for it
+ ( re.compile("(?P<m>VLIB_CLI_COMMAND)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
+ r"/** @brief (@em constructor) \g<m> (\g<name>) */ vlib_cli_command_t \g<name>"),
+ ( re.compile("(?P<m>VLIB_CLI_COMMAND)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<qual>[^)]*)[)]"),
+ r"/** @brief (@em constructor) \g<m> (\g<name>) */ \g<qual> vlib_cli_command_t \g<name>"),
+
+ # Search for VLIB_REGISTER_NODE, extract its parameters and add a docblock for it
+ ( re.compile("(?P<m>VLIB_REGISTER_NODE)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
+ r"/** @brief (@em constructor) \g<m> (\g<name>) */ vlib_node_registration_t \g<name>"),
+ ( re.compile("(?P<m>VLIB_REGISTER_NODE)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<qual>[^)]*)[)]"),
+ r"/** @brief (@em constructor) \g<m> (\g<name>) */ \g<qual> vlib_node_registration_t \g<name>"),
# Search for VLIB_INIT_FUNCTION, extract its parameter and add a docblock for it
- ( re.compile("(?P<m>VLIB_INIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"), r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ vlib_init_function_t * _vlib_init_function_\g<name>"),
- ( re.compile("(?P<m>VLIB_DECLARE_INIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"), r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ vlib_init_function_t * _vlib_init_function_\g<name>"),
+ ( re.compile("(?P<m>VLIB_INIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
+ r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ vlib_init_function_t * _vlib_init_function_\g<name>"),
+ ( re.compile("(?P<m>VLIB_DECLARE_INIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
+ r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ vlib_init_function_t * _vlib_init_function_\g<name>"),
+
+ # Search for VLIB_LOOP_ENTER_FUNCTION, extract the parameters and add a docblock for it
+ ( re.compile("(?P<m>VLIB_MAIN_LOOP_ENTER_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"),
+ r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ _vlib_main_loop_enter_\g<name>"),
+ ( re.compile("(?P<m>VLIB_MAIN_LOOP_EXIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"),
+ r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ _vlib_main_loop_exit_\g<name>"),
+
+ # Search for VLIB_CONFIG_FUNCTION, extract the parameters and add a docblock for it
+ ( re.compile("(?P<m>VLIB_CONFIG_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<n>\"[^\"]+\")(,[^)]*)?[)]"),
+ r"/** @brief (@em constructor) \g<m> (\g<name>, \g<n>) */ vlib_config_function_runtime_t _vlib_config_function_\g<name>"),
+ ( re.compile("(?P<m>VLIB_EARLY_CONFIG_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<n>\"[^\"]+\")(,[^)]*)?[)]"),
+ r"/** @brief (@em constructor) \g<m> (\g<name>, \g<n>) */ vlib_config_function_runtime_t _vlib_config_function_\g<name>"),
- # Search for VLIB_LOOP_ENTER_FUNCTION, extract the 1st parameter (ignore any others) and add a docblock for it
- ( re.compile("(?P<m>VLIB_MAIN_LOOP_ENTER_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"), r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ _vlib_main_loop_enter_\g<name>"),
- ( re.compile("(?P<m>VLIB_MAIN_LOOP_EXIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"), r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ _vlib_main_loop_exit_\g<name>"),
+ # Search for "format_thing" and "unformat_thing" when used as a function pointer and add parens
+ ( re.compile("(?P<pre>(^|,)\s*)(?P<name>(un)?format_[a-zA-Z0-9_]+)(?P<post>\s*(,|$))"),
+ r"\g<pre>\g<name>()\g<post>" ),
- # Search for VLIB_CONFIG_FUNCTION, extract the 1st parameter (ignore any others) and add a docblock for it
- ( re.compile("(?P<m>VLIB_CONFIG_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<n>\"[^\"]+\")(,[^)]*)?[)]"), r"/** @brief (@em constructor) \g<m> (\g<name>, \g<n>) */ vlib_config_function_runtime_t _vlib_config_function_\g<name>"),
- ( re.compile("(?P<m>VLIB_EARLY_CONFIG_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<n>\"[^\"]+\")(,[^)]*)?[)]"), r"/** @brief (@em constructor) \g<m> (\g<name>, \g<n>) */ vlib_config_function_runtime_t _vlib_config_function_\g<name>"),
+ # Search for CLIB_PAD_FROM_TO(...); and replace with padding
+ # #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
+ ( re.compile("(?P<m>CLIB_PAD_FROM_TO)\s*[(](?P<from>[^,]+),\s*(?P<to>[^)]+)[)]"),
+ r"/** Padding. */ u8 pad_\g<from>[(\g<to>) - (\g<from>)]" ),
- # Search for "format_thing" and "unformat_thing" when used as a function pointer and add parens
- ( re.compile("(?P<pre>(^|,)\s*)(?P<name>(un)?format_[a-zA-Z0-9_]+)(?P<post>\s*(,|$))") , r"\g<pre>\g<name>()\g<post>" ),
]
--- /dev/null
+#!/usr/bin/env python
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Filter for .c files to make various preprocessor tricks Doxygenish
+
+import os, sys, re
+
+if len(sys.argv) < 2:
+ sys.stderr.write("Usage: %s <filename>\n" % (sys.argv[0]))
+ sys.exit(1)
+
+replace_patterns = [
+ # Search for CLIB_PAD_FROM_TO(...); and replace with padding
+ # #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
+ ( re.compile("(?P<m>CLIB_PAD_FROM_TO)\s*[(](?P<from>[^,]+),\s*(?P<to>[^)]+)[)]"),
+ r"/** Padding. */ u8 pad_\g<from>[(\g<to>) - (\g<from>)]" ),
+
+]
+
+
+filename = sys.argv[1]
+cwd = os.getcwd()
+if filename[0:len(cwd)] == cwd:
+ filename = filename[len(cwd):]
+ if filename[0] == "/":
+ filename = filename[1:]
+
+with open(filename) as fd:
+ line_num = 0
+
+ for line in fd:
+ line_num += 1
+ str = line[:-1] # filter \n
+
+ # Look for search/replace patterns
+ for p in replace_patterns:
+ str = p[0].sub(p[1], str)
+
+ sys.stdout.write(str+"\n")
+
+# All done
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
+/**
+ * @file
+ * Interface CLI.
+ */
+
#include <vnet/vnet.h>
#include <vnet/ip/ip.h>
#include <vppinfra/bitmap.h>
};
/* *INDENT-ON* */
-/** \detail
+/**
+ * Parse subinterface names.
+ *
* The following subinterface syntax is supported. The first two are for
* backwards compatability:
*
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
-/** @file Definitions for all things IP (v4|v6) unicast and multicast lookup related.
- - Adjacency definitions and registration
- - callbacks on route add
- - callbacks on interface address change
+/**
+ * @file
+ * Definitions for all things IP (v4|v6) unicast and multicast lookup related.
+ *
+ * - Adjacency definitions and registration.
+ * - Callbacks on route add.
+ * - Callbacks on interface address change.
*/
+
#ifndef included_ip_lookup_h
#define included_ip_lookup_h
* limitations under the License.
*/
/**
- * @file error.def
+ * @file
* @brief L2-GRE over IPSec errors.
*/
* limitations under the License.
*/
/**
- * @file interface.c
+ * @file
* @brief L2-GRE over IPSec tunnel interface.
*
* Creates ipsec-gre tunnel interface.
* limitations under the License.
*/
/**
- * @file ipsec_gre.c
+ * @file
* @brief L2-GRE over IPSec packet processing.
*
* Add GRE header to thr packet and send it to the esp-encrypt node.
* limitations under the License.
*/
/**
- * @file ipsec_gre.h
+ * @file
* @brief L2-GRE over IPSec packet processing.
*/
* limitations under the License.
*/
/**
- * @file node.c
+ * @file
* @brief L2-GRE over IPSec packet processing.
*
- * Removes GRE header from the packet and send it to the l2-input node.
+ * Removes GRE header from the packet and sends it to the l2-input node.
*/
#include <vlib/vlib.h>
*
* @par Graph mechanics: buffer metadata, next index usage
*
- * <em>Uses:<em>
+ * <em>Uses:</em>
* - <code>ip->src_address</code> and <code>ip->dst_address</code>
* - Match tunnel by source and destination addresses in GRE IP header.
*
bd_main_t bd_main;
/**
- Init bridge domain if not done already
+ Init bridge domain if not done already.
For feature bitmap, set all bits except ARP termination
*/
void
/**
- Set the learn/forward/flood flags for the bridge domain
+ Set the learn/forward/flood flags for the bridge domain.
Return 0 if ok, non-zero if for an error.
*/
u32
}
/**
- set bridge-domain learn enable/disable
+ Set bridge-domain learn enable/disable.
The CLI format is:
set bridge-domain learn <bd_id> [disable]
*/
/* *INDENT-ON* */
/**
- set bridge-domain forward enable/disable
+ Set bridge-domain forward enable/disable.
The CLI format is:
set bridge-domain forward <bd_index> [disable]
*/
/* *INDENT-ON* */
/**
- set bridge-domain flood enable/disable
+ Set bridge-domain flood enable/disable.
The CLI format is:
set bridge-domain flood <bd_index> [disable]
*/
/* *INDENT-ON* */
/**
- set bridge-domain unkown-unicast flood enable/disable
+ Set bridge-domain unkown-unicast flood enable/disable.
The CLI format is:
set bridge-domain uu-flood <bd_index> [disable]
*/
/* *INDENT-ON* */
/**
- set bridge-domain arp term enable/disable
+ Set bridge-domain arp term enable/disable.
The CLI format is:
set bridge-domain arp term <bridge-domain-id> [disable]
*/
/**
+ * Add/delete IP address to MAC address mapping.
+ *
* The clib hash implementation stores uword entries in the hash table.
* The hash table mac_by_ip4 is keyed via IP4 address and store the
* 6-byte MAC address directly in the hash table entry uword.
- * This only works for 64-bit processor with 8-byte uword; which means
- * this code *WILL NOT WORK* for a 32-bit prcessor with 4-byte uword.
+ *
+ * @warning This only works for 64-bit processor with 8-byte uword;
+ * which means this code *WILL NOT WORK* for a 32-bit prcessor with
+ * 4-byte uword.
*/
u32
bd_add_del_ip_mac (u32 bd_index,
}
/**
- set bridge-domain arp entry add/delete
+ Set bridge-domain arp entry add/delete.
The CLI format is:
set bridge-domain arp entry <bd-id> <ip-addr> <mac-addr> [del]
*/
}
/**
- show bridge-domain state
+ Show bridge-domain state.
The CLI format is:
show bridge-domain [<bd_index>]
*/
/**
* Extract fields from the packet that will be used in interface
- * classification
+ * classification.
*/
static_always_inline void
extract_keys (vnet_main_t * vnet_main,
VLIB_INIT_FUNCTION (l2_efp_filter_init);
-/** Enable/disable the EFP Filter check on the subinterface */
+/** Enable/disable the EFP Filter check on the subinterface. */
void
l2_efp_filter_configure (vnet_main_t * vnet_main, u32 sw_if_index, u32 enable)
{
/**
- * set subinterface egress efp filter enable/disable
+ * Set subinterface egress efp filter enable/disable.
* The CLI format is:
* set interface l2 efp-filter <interface> [disable]]
*/
}
}
-/** Display the contents of the l2fib */
+/** Display the contents of the l2fib. */
static clib_error_t *
show_l2fib (vlib_main_t * vm,
unformat_input_t * input, vlib_cli_command_t * cmd)
l2learn_main.global_learn_count = 0;
}
-/** Clear all entries in L2FIB
- * TODO: Later we may want a way to remove only the non-static entries
+/** Clear all entries in L2FIB.
+ * @TODO: Later we may want a way to remove only the non-static entries
*/
static clib_error_t *
clear_l2fib (vlib_main_t * vm,
}
/**
- * Add an entry to the L2FIB
+ * Add an entry to the L2FIB.
* The CLI format is:
* l2fib add <mac> <bd> <intf> [static] [bvi]
* l2fib add <mac> <bd> filter
}
/**
- * Delete an entry from the L2FIB
+ * Delete an entry from the L2FIB.
* The CLI format is:
* l2fib del <mac> <bd-id>
*/
-/** Add the L3 input node for this ethertype to the next nodes structure */
+/** Add the L3 input node for this ethertype to the next nodes structure. */
void
l2flood_register_input_type (vlib_main_t * vm,
ethernet_type_t type, u32 node_index)
/**
- * set subinterface flood enable/disable
+ * Set subinterface flood enable/disable.
* The CLI format is:
* set interface l2 flood <interface> [disable]
*/
L2FWD_N_NEXT,
} l2fwd_next_t;
-/** Forward one packet based on the mac table lookup result */
+/** Forward one packet based on the mac table lookup result. */
static_always_inline void
l2fwd_process (vlib_main_t * vm,
VLIB_INIT_FUNCTION (l2fwd_init);
-/** Add the L3 input node for this ethertype to the next nodes structure */
+/** Add the L3 input node for this ethertype to the next nodes structure. */
void
l2fwd_register_input_type (vlib_main_t * vm,
ethernet_type_t type, u32 node_index)
/**
- * set subinterface forward enable/disable
+ * Set subinterface forward enable/disable.
* The CLI format is:
* set interface l2 forward <interface> [disable]
*/
VLIB_INIT_FUNCTION (l2input_init);
-/** Get a pointer to the config for the given interface */
+/** Get a pointer to the config for the given interface. */
l2_input_config_t *
l2input_intf_config (u32 sw_if_index)
{
return vec_elt_at_index (mp->configs, sw_if_index);
}
-/** Enable (or disable) the feature in the bitmap for the given interface */
+/** Enable (or disable) the feature in the bitmap for the given interface. */
u32
l2input_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
{
/**
* Set the subinterface to run in l2 or l3 mode.
- * for L3 mode, just the sw_if_index is specified
- * for bridged mode, the bd id and bvi flag are also specified
- * for xconnect mode, the peer sw_if_index is also specified
- * Return 0 if ok, or non-0 if there was an error
+ * For L3 mode, just the sw_if_index is specified.
+ * For bridged mode, the bd id and bvi flag are also specified.
+ * For xconnect mode, the peer sw_if_index is also specified.
+ * Return 0 if ok, or non-0 if there was an error.
*/
u32
}
/**
- * set subinterface in bridging mode with a bridge-domain ID
+ * Set subinterface in bridging mode with a bridge-domain ID.
* The CLI format is:
* set interface l2 bridge <interface> <bd> [bvi] [split-horizon-group]
*/
/* *INDENT-ON* */
/**
- * set subinterface in xconnect mode with another interface
+ * Set subinterface in xconnect mode with another interface.
* The CLI format is:
* set interface l2 xconnect <interface> <peer interface>
*/
/* *INDENT-ON* */
/**
- * set subinterface in L3 mode
+ * Set subinterface in L3 mode.
* The CLI format is:
* set interface l3 <interface>
*/
/* *INDENT-ON* */
/**
+ * Show interface mode.
* The CLI format is:
* show mode [<if-name1> <if-name2> ...]
*/
/**
* @file
- * @brief L2 input classifier
+ * @brief L2 input classifier.
*
- * See also .../vnet/vnet/classify/vnet_classify.[ch]
+ * @sa @ref vnet/vnet/classify/vnet_classify.c
+ * @sa @ref vnet/vnet/classify/vnet_classify.h
*/
/**
- * @brief l2_input_classifier packet trace record
+ * @brief l2_input_classifier packet trace record.
*/
typedef struct
{
} l2_input_classify_trace_t;
/**
- * @brief vlib node runtime
+ * @brief vlib node runtime.
*/
typedef struct
{
l2_input_classify_main_t *l2cm;
} l2_input_classify_runtime_t;
-/** packet trace format function */
+/** Packet trace format function. */
static u8 *
format_l2_input_classify_trace (u8 * s, va_list * args)
{
return s;
}
-/** l2 input classifier main data structure */
+/** l2 input classifier main data structure. */
l2_input_classify_main_t l2_input_classify_main;
vlib_node_registration_t l2_input_classify_node;
* @em Uses:
* - <code>(l2_input_classify_runtime_t *)
* rt->classify_table_index_by_sw_if_index</code>
- * Head of the per-interface, perprotocol classifier table chain
- * for a specific interface. ~0 => send pkts to the next
- * feature in the L2 feature chain.
+ * - Head of the per-interface, per-protocol classifier table chain
+ * for a specific interface.
+ * - @c ~0 => send pkts to the next feature in the L2 feature chain.
* - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
* - Indicates the @c sw_if_index value of the interface that the
- * packet was received on.
- * - <code>vnet_buffer (b0)->l2.feature_bitmap</code>
+ * packet was received on.
+ * - <code>vnet_buffer(b0)->l2.feature_bitmap</code>
* - Used to steer packets across l2 features enabled on the interface
* - <code>(vnet_classify_entry_t) e0->next_index</code>
* - Used to steer traffic when the classifier hits on a session
* - <code>(vnet_classify_entry_t) e0->advance</code>
* - Signed quantity applied via <code>vlib_buffer_advance</code>
- * when the classifier hits on a session
+ * when the classifier hits on a session
* - <code>(vnet_classify_table_t) t0->miss_next_index</code>
* - Used to steer traffic when the classifier misses
*
VLIB_NODE_FUNCTION_MULTIARCH (l2_input_classify_node,
l2_input_classify_node_fn);
-/** l2 input classsifier feature initialization */
+/** l2 input classsifier feature initialization. */
clib_error_t *
l2_input_classify_init (vlib_main_t * vm)
{
VLIB_INIT_FUNCTION (l2_input_classify_init);
-/** enable/disable l2 input classification on a specific interface */
+/** Enable/disable l2 input classification on a specific interface. */
void
vnet_l2_input_classify_enable_disable (u32 sw_if_index, int enable_disable)
{
(u32) enable_disable);
}
-/** @brief Set l2 per-protocol, per-interface input classification tables
+/** @brief Set l2 per-protocol, per-interface input classification tables.
*
* @param sw_if_index interface handle
* @param ip4_table_index ip4 classification table index, or ~0
#include <vppinfra/error.h>
#include <vppinfra/hash.h>
-/*
- * Ethernet bridge learning
+/**
+ * @file
+ * Ethernet bridge learning.
*
* Populate the mac table with entries mapping the packet's source mac + bridge
* domain ID to the input sw_if_index.
} l2learn_next_t;
-/** Perform learning on one packet based on the mac table lookup result */
+/** Perform learning on one packet based on the mac table lookup result. */
static_always_inline void
l2learn_process (vlib_node_runtime_t * node,
/**
- * set subinterface learn enable/disable
+ * Set subinterface learn enable/disable.
* The CLI format is:
* set interface l2 learn <interface> [disable]
*/
};
/**
- * Return 0 if split horizon check passes, otherwise return non-zero
+ * Check for split horizon violations.
+ * Return 0 if split horizon check passes, otherwise return non-zero.
* Packets should not be transmitted out an interface with the same
- * split-horizon group as the input interface, except if the shg is 0
+ * split-horizon group as the input interface, except if the @c shg is 0
* in which case the check always passes.
*/
static_always_inline u32
#endif
-/** Create a mapping in the next node mapping table for the given sw_if_index */
+/** Create a mapping in the next node mapping table for the given sw_if_index. */
u32
l2output_create_output_node_mapping (vlib_main_t * vlib_main, vnet_main_t * vnet_main, u32 node_index, /* index of current node */
u32 * output_node_index_vec,
return vec_elt_at_index (mp->configs, sw_if_index);
}
-/** Enable (or disable) the feature in the bitmap for the given interface */
+/** Enable (or disable) the feature in the bitmap for the given interface. */
void
l2output_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
{
VLIB_INIT_FUNCTION (l2_outacl_init);
#if 0
-/** @todo maybe someone will add output ACL's in the future
- * set subinterface outacl enable/disable
+/** @todo maybe someone will add output ACL's in the future.
+ * Set subinterface outacl enable/disable.
* The CLI format is:
* set interface acl output <interface> [disable]
*/
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-/*
- * l2_classify.c
- */
#include <vnet/l2/l2_classify.h>
#include <vnet/api_errno.h>
/**
* @file
- * @brief L2 input classifier
+ * @brief L2 input classifier.
*
- * See also .../vnet/vnet/classify/vnet_classify.[ch]
+ * @sa @ref vnet/vnet/classify/vnet_classify.c
+ * @sa @ref vnet/vnet/classify/vnet_classify.h
*/
typedef struct
l2_output_classify_main_t *l2cm;
} l2_output_classify_runtime_t;
-/** packet trace format function */
+/** Packet trace format function. */
static u8 *
format_l2_output_classify_trace (u8 * s, va_list * args)
{
return s;
}
-/** l2 output classifier main data structure */
+/** l2 output classifier main data structure. */
l2_output_classify_main_t l2_output_classify_main;
vlib_node_registration_t l2_output_classify_node;
VLIB_NODE_FUNCTION_MULTIARCH (l2_output_classify_node,
l2_output_classify_node_fn);
-/** l2 output classsifier feature initialization */
+/** l2 output classsifier feature initialization. */
clib_error_t *
l2_output_classify_init (vlib_main_t * vm)
{
VLIB_INIT_FUNCTION (l2_output_classify_init);
-/** enable/disable l2 input classification on a specific interface */
+/** Enable/disable l2 input classification on a specific interface. */
void
vnet_l2_output_classify_enable_disable (u32 sw_if_index, int enable_disable)
{
(u32) enable_disable);
}
-/** @brief Set l2 per-protocol, per-interface output classification tables
+/** @brief Set l2 per-protocol, per-interface output classification tables.
*
- * @param sw_if_index interface handle
- * @param ip4_table_index ip4 classification table index, or ~0
- * @param ip6_table_index ip6 classification table index, or ~0
+ * @param sw_if_index interface handle
+ * @param ip4_table_index ip4 classification table index, or ~0
+ * @param ip6_table_index ip6 classification table index, or ~0
* @param other_table_index non-ip4, non-ip6 classification table index,
* or ~0
* @returns 0 on success, VNET_API_ERROR_NO_SUCH_TABLE, TABLE2, TABLE3
- * if the indicated (non-~0) table does not exist.
+ * if the indicated (non-~0) table does not exist.
*/
int
#include <vlib/cli.h>
-/** Just a placeholder. Also ensures file is not eliminated by linker. */
+/** Just a placeholder; ensures file is not eliminated by linker. */
clib_error_t *
l2_vtr_init (vlib_main_t * vm)
{
}
/**
- * Get vtag tag rewrite on the given interface.
+ * Get vtag tag rewrite on the given interface.
* Return 1 if there is an error, 0 if ok
*/
u32
}
/**
- * set subinterface vtr enable/disable
+ * Set subinterface vtr enable/disable.
* The CLI format is:
* set interface l2 tag-rewrite <interface> [disable | pop 1 | pop 2 | push {dot1q|dot1ad} <tag> [<tag>]]
*
*/
#include <vnet/l2/l2_xcrw.h>
-/*
+/**
+ * @file
* General L2 / L3 cross-connect, used to set up
* "L2 interface <--> your-favorite-tunnel-encap" tunnels.
*
}
/**
- * @brief workaround for a known #include bug
- * #include <linux/ipv6.h> causes multiple definitions if
- * netinet/in.h is also included.
+ * @brief workaround for a known include file bug.
+ * including @c <linux/ipv6.h> causes multiple definitions if
+ * @c <netinet/in.h is also included.
*/
struct in6_ifreq {
struct in6_addr ifr6_addr;
};
/**
- * @brief Add or Del tun/tap interface address
+ * @brief Add or Del tun/tap interface address.
*
* Both the v6 interface address API and the way ifconfig
* displays subinterfaces differ from their v4 couterparts.
* limitations under the License.
*/
-/** @if DOCUMENTATION_IS_IN_BIHASH_DOC_H */
+/** @cond DOCUMENTATION_IS_IN_BIHASH_DOC_H */
void BV (clib_bihash_init)
(BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size)
}
}
-/** @endif */
+/** @endcond */
/*
* fd.io coding-style-patch-verification: ON
* limitations under the License.
*/
-/** @if DOCUMENTATION_IS_IN_BIHASH_DOC_H */
+/** @cond DOCUMENTATION_IS_IN_BIHASH_DOC_H */
/*
* Note: to instantiate the template multiple times in a single file,
#endif /* __included_bihash_template_h__ */
-/** @endif */
+/** @endcond */
/*
* fd.io coding-style-patch-verification: ON
Code Review / vpp.git / commitdiff