Fix various minor Doxygen warnings.

This commit is contained in:
Sadie Powell 2022-02-02 14:15:57 +00:00
parent 170a26e72b
commit 744f8b4604
3 changed files with 5 additions and 4 deletions

View File

@ -1,6 +1,6 @@
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = InspIRCd
PROJECT_NUMBER = 3.0
PROJECT_NUMBER = v3
PROJECT_BRIEF =
PROJECT_LOGO =
OUTPUT_DIRECTORY = docs/doxygen
@ -239,6 +239,7 @@ SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = CoreExport=/**/ \
DEPRECATED_METHOD(X)=X \
INSPIRCD_INTRUSIVE_LIST_NAME=intrusive_list
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES

View File

@ -56,7 +56,7 @@ enum TranslateType
/** Routing types for a command. Any command which is created defaults
* to having its command broadcasted on success. This behaviour may be
* overridden to one of the route types shown below (see the #defines
* overridden to one of the route types shown below (see the \#defines
* below for more information on each one's behaviour)
*/
enum RouteType
@ -100,7 +100,7 @@ struct RouteDescriptor
#define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, ""))
/** Route this command to a single server (do nothing if own server name specified) */
#define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x))
/** Route this command as a message with the given target (any of user, #channel, @#channel, $servermask) */
/** Route this command as a message with the given target (any of user, \#channel, @#channel, $servermask) */
#define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x))
/** Route this command to all servers wrapped via ENCAP, so ignored if not understood */
#define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, ""))

View File

@ -129,7 +129,7 @@ class ModResult
};
/**
* This #define allows us to call a method in all
* This \#define allows us to call a method in all
* loaded modules in a readable simple way, e.g.:
* 'FOREACH_MOD(OnConnect,(user));'
*/