Fix a few documentation errors in MDNS

This commit is contained in:
Dirk Ziegelmeier 2019-02-02 22:44:57 +01:00
parent dc607c5be4
commit 27c226b5d6
2 changed files with 3 additions and 3 deletions

View File

@ -2503,7 +2503,7 @@ mdns_resp_add_service_txtitem(struct mdns_service *service, const char *txt, u8_
/**
* @ingroup mdns
* Stop a search request.
* @param req The search request to stop
* @param request_id The search request to stop
*/
void
mdns_search_stop(s8_t request_id)

View File

@ -139,7 +139,7 @@ mdns_domain_add_label_pbuf(struct mdns_domain *domain, const struct pbuf *p, u16
/**
* Add a partial domain to a domain
* @param domain The domain to add a label to
* @param source The domain to add, like <\x09_services\007_dns-sd\000>
* @param source The domain to add, like <\\x09_services\\007_dns-sd\\000>
* @return ERR_OK on success, an err_t otherwise if label too long
*/
err_t
@ -500,7 +500,7 @@ mdns_build_service_domain(struct mdns_domain *domain, struct mdns_service *servi
* @param request The request struct, containing service name, type and protocol
* @param include_name Whether to include the service name in the domain
* @return ERR_OK if domain was written. If service name is included,
* <name>.<type>.<proto>.local. will be written, otherwise <type>.<proto>.local.
* \<name\>.\<type\>.\<proto\>.local. will be written, otherwise \<type\>.\<proto\>.local.
* An err_t is returned on error.
*/
err_t