Document apps in doxygen module style, create more top-level categories to structure documentation

This commit is contained in:
Dirk Ziegelmeier
2016-07-26 19:30:05 +02:00
parent 8a9de94b1f
commit c6831648e2
15 changed files with 128 additions and 36 deletions

View File

@@ -1,6 +1,11 @@
/**
* @file
* NetBIOS name service responder
*/
/**
* @defgroup netbiosns NETBIOS responder
* @ingroup apps
*
* This is an example implementation of a NetBIOS name server.
* It responds to name queries for a configurable name.
@@ -308,6 +313,10 @@ netbiosns_recv(void *arg, struct udp_pcb *upcb, struct pbuf *p, const ip_addr_t
}
}
/**
* @ingroup netbiosns
* Init netbios responder
*/
void
netbiosns_init(void)
{
@@ -325,7 +334,10 @@ netbiosns_init(void)
}
#ifndef NETBIOS_LWIP_NAME
/* ATTENTION: the hostname must be <= 15 characters! */
/**
* @ingroup netbiosns
* Set netbios name. ATTENTION: the hostname must be less than 15 characters!
*/
void
netbiosns_set_name(const char* hostname)
{
@@ -338,6 +350,10 @@ netbiosns_set_name(const char* hostname)
}
#endif
/**
* @ingroup netbiosns
* Stop netbios responder
*/
void
netbiosns_stop(void)
{