[lwip-devel] [bug #65848] generate.sh errors out due to wrong return type comments in snmp_traps.c

[stefanct]

URL:
  <https://savannah.nongnu.org/bugs/?65848>

                 Summary: generate.sh errors out due to wrong return type
comments in snmp_traps.c
                   Group: lwIP - A Lightweight TCP/IP stack
               Submitter: stefanct
               Submitted: Sat 08 Jun 2024 12:03:41 AM UTC
                Category: Documentation
                Severity: 3 - Normal
              Item Group: None
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None
            lwIP version: git head


    _______________________________________________________

Follow-up Comments:


-------------------------------------------------------
Date: Sat 08 Jun 2024 12:03:41 AM UTC By: stefanct <stefanct>
as of 86c9f7999150199374d7697fd2eed62dcd9b1afa, executing
doc/doxygen/generate.sh ends with this error:
src/apps/snmp/snmp_traps.c:511: error: found documented return type for
snmp_authfail_trap that does not return anything (warning treated as error,
aborting now)


This is only one of multiple such errors in two groups. Attached patch fixes
the instances of void functions by removing the "@retval void" and the
functions with return type err_t by replacing it with "@return ERR_OK if
successful".

With this applied generate.sh runs through.






    _______________________________________________________
File Attachments:


-------------------------------------------------------
Name: 0001-snmp_traps.c-fix-return-type-documentation-of-multip.patch  Size:
4KiB
<https://file.savannah.nongnu.org/file/0001-snmp_traps.c-fix-return-type-documentation-of-multip.patch?file_id=56146>

    AGPL NOTICE

These attachments are served by Savane. You can download the corresponding
source code of Savane at
https://git.savannah.nongnu.org/cgit/administration/savane.git/snapshot/savane-e21a9f0b308156a6d1b2f4c9f7a463f076b621b8.tar.gz

    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/bugs/?65848>

_______________________________________________
Message sent via Savannah
https://savannah.nongnu.org/