[lwip-devel] Problem with Doxygen

[Gisle Vanem]

I have an issue with generating the Doxygen HTML
(and a Lwip.chm). During the process I get this error:

        src/api/api_lib.c:1258:
        error: argument 'dns_addrtype' of command @param is not found
        in the argument list of netconn_gethostbyname(const char *name, 
ip_addr_t *addr)
        (warning treated as error, aborting now)

I'm not sure how the Doxygen preprocessor works. But AFAICS, all
'LWIP_x' values are '1' while '__DOXYGEN__' is defined.
Setting 'WARN_AS_ERROR=NO', the generated .chm for this function
looks like in the attached screen-shot.

Doxygen seems to be correct; there is no 'dns_addrtype'
parameter for 'netconn_gethostbyname()'. How to solve this
best?

Besides, there are these warning:
     src/core/altcp_tcp.c:213: warning: unable to resolve reference
     to 'altcp_allocator_t' for \ref command

     src/core/altcp.c:44: warning: unable to resolve reference to 
'altcp_allocator_t' for \ref command
     src/core/altcp.c:46: warning: unable to resolve reference to 
'altcp_allocator_t' for \ref command
     src/core/raw.c:626: warning: unable to resolve reference to 'IP_ANY_TYPE' 
for \ref command
     src/core/tcp.c:1963: warning: unable to resolve reference to 'IP_ANY_TYPE' 
for \ref command
     src/core/udp.c:1253: warning: unable to resolve reference to 'IP_ANY_TYPE' 
for \ref command
     src/core/altcp_alloc.c:79: warning: unable to resolve reference to 
'altcp_allocator_t' for \ref command
     src/include/lwip/apps/httpd_opts.h:56: warning: unable to resolve 
reference to 'http_set_cgi_handlers'
     for \ref command

The 2 first, I fixed by:

--- a/src/include/lwip/altcp.h 2019-04-22 11:15:35
+++ b/src/include/lwip/altcp.h 2020-09-28 11:08:46
@@ -80,7 +80,9 @@
       u8_t pollinterval;
     };

-/** @ingroup altcp */
+/** @ingroup altcp
+ * The altcp allocator structure
+ */
     typedef struct altcp_allocator_s {
       /** Allocator function */
       altcp_new_fn  alloc;

And the last:

--- a/src/include/lwip/apps/httpd.h 2018-10-02 20:20:36
+++ b/src/include/lwip/apps/httpd.h 2020-09-28 11:24:00
@@ -95,6 +95,9 @@
      tCGIHandler pfnCGIHandler;
  } tCGI;

+/**
+ * The associated function which is to be called when that URL is requested.
+ */
  void http_set_cgi_handlers(const tCGI *pCGIs, int iNumHandlers);

-------

The warning on 'IP_ANY_TYPE', I fail to understand.

--
--gv

lwip-netconn_gethostbyname.png
Description: PNG image