Add NETBIOSNS options to doxygen docs

This commit is contained in:
Dirk Ziegelmeier 2016-07-28 08:05:57 +02:00
parent 93ad162aa6
commit f7e12d835c

View File

@ -34,13 +34,19 @@
#include "lwip/opt.h" #include "lwip/opt.h"
/**
* @defgroup netbiosns_opts Options
* @ingroup netbiosns
* @{
*/
/** Since there's no standard function for case-insensitive string comparision, /** Since there's no standard function for case-insensitive string comparision,
* we need another define here: * we need another define here:
* define this to stricmp() for windows or strcasecmp() for linux. * define this to stricmp() for windows or strcasecmp() for linux.
* If not defined, comparision is case sensitive and the provided hostname must be * If not defined, comparision is case sensitive and the provided hostname must be
* uppercase. * uppercase.
*/ */
#ifndef NETBIOS_STRCMP #if !defined NETBIOS_STRCMP || defined __DOXYGEN__
#define NETBIOS_STRCMP(str1, str2) strcmp(str1, str2) #define NETBIOS_STRCMP(str1, str2) strcmp(str1, str2)
#endif #endif
@ -52,7 +58,12 @@
* *
* If this is not defined, netbiosns_set_name() can be called at runtime to change the name. * If this is not defined, netbiosns_set_name() can be called at runtime to change the name.
*/ */
/*#define NETBIOS_LWIP_NAME "NETBIOSLWIPDEV"*/ #ifdef __DOXYGEN__
#define NETBIOS_LWIP_NAME "NETBIOSLWIPDEV"
#endif
/**
* @}
*/
#endif /* LWIP_HDR_APPS_NETBIOS_OPTS_H */ #endif /* LWIP_HDR_APPS_NETBIOS_OPTS_H */