Touched up some of the Doxygen tags.
This commit is contained in:
@@ -31,7 +31,7 @@ PROJECT_NAME = BAC-stack
|
|||||||
# This could be handy for archiving the generated documentation or
|
# This could be handy for archiving the generated documentation or
|
||||||
# if some version control system is used.
|
# if some version control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = 0.5.8
|
PROJECT_NUMBER = 0.5.9-prelim
|
||||||
|
|
||||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
||||||
# base path where the generated documentation will be put.
|
# base path where the generated documentation will be put.
|
||||||
@@ -1108,7 +1108,7 @@ INCLUDE_FILE_PATTERNS =
|
|||||||
# undefined via #undef or recursively expanded use the := operator
|
# undefined via #undef or recursively expanded use the := operator
|
||||||
# instead of the = operator.
|
# instead of the = operator.
|
||||||
|
|
||||||
PREDEFINED = FOR_DOXYGEN
|
PREDEFINED = FOR_DOXYGEN BAC_ROUTING
|
||||||
|
|
||||||
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
||||||
# this tag can be used to specify a list of macro names that should be expanded.
|
# this tag can be used to specify a list of macro names that should be expanded.
|
||||||
@@ -1201,7 +1201,7 @@ HIDE_UNDOC_RELATIONS = YES
|
|||||||
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
||||||
# have no effect if this option is set to NO (the default)
|
# have no effect if this option is set to NO (the default)
|
||||||
|
|
||||||
HAVE_DOT = NO
|
HAVE_DOT = YES
|
||||||
|
|
||||||
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
||||||
# will generate a graph for each documented class showing the direct and
|
# will generate a graph for each documented class showing the direct and
|
||||||
|
|||||||
@@ -52,6 +52,7 @@
|
|||||||
* This handler is called if the NCPI bit 7 indicates that this packet is a
|
* This handler is called if the NCPI bit 7 indicates that this packet is a
|
||||||
* network layer message and there is no further DNET to pass it to.
|
* network layer message and there is no further DNET to pass it to.
|
||||||
* The NCPI has already been decoded into the npdu_data structure.
|
* The NCPI has already been decoded into the npdu_data structure.
|
||||||
|
* @ingroup MISCHNDLR
|
||||||
*
|
*
|
||||||
* @param src [in] The routing source information, if any.
|
* @param src [in] The routing source information, if any.
|
||||||
* If src->net and src->len are 0, there is no
|
* If src->net and src->len are 0, there is no
|
||||||
|
|||||||
@@ -34,6 +34,7 @@
|
|||||||
#include "whois.h"
|
#include "whois.h"
|
||||||
#include "iam.h"
|
#include "iam.h"
|
||||||
#include "device.h"
|
#include "device.h"
|
||||||
|
|
||||||
#include "client.h"
|
#include "client.h"
|
||||||
#include "txbuf.h"
|
#include "txbuf.h"
|
||||||
#include "handlers.h"
|
#include "handlers.h"
|
||||||
@@ -170,6 +171,7 @@ static void check_who_is_for_routing(
|
|||||||
|
|
||||||
/** Handler for Who-Is requests in the virtual routing setup,
|
/** Handler for Who-Is requests in the virtual routing setup,
|
||||||
* with broadcast I-Am response(s).
|
* with broadcast I-Am response(s).
|
||||||
|
* @ingroup DMDDB
|
||||||
* Will check the gateway (root Device) and all virtual routed
|
* Will check the gateway (root Device) and all virtual routed
|
||||||
* Devices against the range and respond for each that matches.
|
* Devices against the range and respond for each that matches.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -112,7 +112,6 @@ void Send_WhoIs_Global(
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** Send a local Who-Is request for a specific device, a range, or any device.
|
/** Send a local Who-Is request for a specific device, a range, or any device.
|
||||||
* @ingroup DMDDB
|
|
||||||
* If low_limit and high_limit both are -1, then the range is unlimited.
|
* If low_limit and high_limit both are -1, then the range is unlimited.
|
||||||
* If low_limit and high_limit have the same non-negative value, then only
|
* If low_limit and high_limit have the same non-negative value, then only
|
||||||
* that device will respond.
|
* that device will respond.
|
||||||
@@ -157,6 +156,7 @@ void Send_WhoIs_Local(
|
|||||||
|
|
||||||
/** Send a Who-Is request to a remote network for a specific device, a range,
|
/** Send a Who-Is request to a remote network for a specific device, a range,
|
||||||
* or any device.
|
* or any device.
|
||||||
|
* @ingroup DMDDB
|
||||||
* If low_limit and high_limit both are -1, then the range is unlimited.
|
* If low_limit and high_limit both are -1, then the range is unlimited.
|
||||||
* If low_limit and high_limit have the same non-negative value, then only
|
* If low_limit and high_limit have the same non-negative value, then only
|
||||||
* that device will respond.
|
* that device will respond.
|
||||||
@@ -177,6 +177,7 @@ void Send_WhoIs_Remote(
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** Send a global Who-Is request for a specific device, a range, or any device.
|
/** Send a global Who-Is request for a specific device, a range, or any device.
|
||||||
|
* @ingroup DMDDB
|
||||||
* This was the original Who-Is broadcast but the code was moved to the more
|
* This was the original Who-Is broadcast but the code was moved to the more
|
||||||
* descriptive Send_WhoIs_Global when Send_WhoIs_Local and Send_WhoIsRemote was
|
* descriptive Send_WhoIs_Global when Send_WhoIs_Local and Send_WhoIsRemote was
|
||||||
* added.
|
* added.
|
||||||
|
|||||||
Reference in New Issue
Block a user