Re: [lwip-devel] clang-cl Doxygen warnings

[address@hidden]

I don't know about @internal, but we're checking the docs on travis with 
clang. Although I don't know with which compiler flags.
It seems that at least in sntp.c, some configs are disabled or the build 
should fail. Feel free to post patches fixing those warnings.

Simon

On 04.07.2018 18:11, Gisle Vanem wrote:
> With 'clang-cl -Wall', there are tons of warning. Not all
> very useful. Except maybe for the "illegal" Doxygen commands:
>
> src/core/mem.c(468,4):  warning: unknown command tag name 
> [-Wdocumentation-unknown-command]
>    * @internal this function is only called by mem_free() and mem_trim()
>      ^~~~~~~~~
> src/core/netif.c(259,51):  warning: unknown command tag name 
> [-Wdocumentation-unknown-command]
>    * ingress packets up in the protocol layer stack.\n
>                                                     ^~
> src/core/pbuf.c(712,4):  warning: unknown command tag name 
> [-Wdocumentation-unknown-command]
>    * @internal examples:
>      ^~~~~~~~~
> src/core/tcp.c(1935,4):  warning: unknown command tag name 
> [-Wdocumentation-unknown-command]
>    * @internal: Maybe there should be a idle TCP PCB list where these
>      ^~~~~~~~~
> -------
>
> A '@internal' command seems legal to me. A bug in clang-cl?
> Besides, the doc/doxygen/lwip.Doxyfile contains a
>     'INTERNAL_DOCS = NO'
>
> Also some clearly typos / old doxy-formatting:
>
> src/apps/sntp/sntp.c(840,11):  warning: parameter 'numdns' not found in the 
> function declaration [-Wdocumentation]
>    * @param numdns the index of the NTP server to set must be < SNTP_MAX_SERVERS
>             ^~~~~~
> src/apps/sntp/sntp.c(841,11):  warning: parameter 'dnsserver' not found in the 
> function declaration [-Wdocumentation]
>    * @param dnsserver DNS name of the NTP server to set, to be resolved at 
> contact time
>             ^~~~~~~~~
> src/apps/sntp/sntp.c(841,11):  note: did you mean 'server'?
>    * @param dnsserver DNS name of the NTP server to set, to be resolved at 
> contact time
>             ^~~~~~~~~
>             server
> src/apps/sntp/sntp.c(855,11):  warning: parameter 'numdns' not found in the 
> function declaration [-Wdocumentation]
>    * @param numdns the index of the NTP server
>             ^~~~~~
> src/apps/sntp/sntp.c(855,11):  note: did you mean 'idx'?
>    * @param numdns the index of the NTP server
>             ^~~~~~
>             idx