[lwip-devel] [patch #10422] Improve doxygen documentation

[Philippe Brais]

URL:
  <https://savannah.nongnu.org/patch/?10422>

                 Summary: Improve doxygen documentation
                   Group: lwIP - A Lightweight TCP/IP stack
               Submitter: pbrais
               Submitted: Mon 01 Jan 2024 10:59:02 PM UTC
                Category: Documentation
                Priority: 5 - Normal
                  Status: None
                 Privacy: Public
             Assigned to: None
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None


    _______________________________________________________

Follow-up Comments:


-------------------------------------------------------
Date: Mon 01 Jan 2024 10:59:02 PM UTC By: Philippe Brais <pbrais>
While reading the Doxygen documentation, I noticed in the page
[https://www.nongnu.org/lwip/2_1_x/sys_init.html System initalization]:
* a missing link of the `netif_add()` function; and
* incorrect indentations in the `netif_add()` bullet point:
        * code block of `netif_if_init` and 
        * following "For Ethernet drivers, the input..." paragraph.

Then, copied Doxygen text of many 'Related Pages' and 'Modules' in Microsoft
Word for spelling and grammar checks.






    _______________________________________________________
File Attachments:


-------------------------------------------------------
Date: Mon 01 Jan 2024 10:59:02 PM UTC  Name: 0001-Fix-typos.patch  Size: 7KiB 
 By: pbrais

<http://savannah.nongnu.org/patch/download.php?file_id=55499>
-------------------------------------------------------
Date: Mon 01 Jan 2024 10:59:02 PM UTC  Name:
0002-Fix-code-block-indentation-in-bullet-point.patch  Size: 1KiB   By: pbrais

<http://savannah.nongnu.org/patch/download.php?file_id=55500>
-------------------------------------------------------
Date: Mon 01 Jan 2024 10:59:02 PM UTC  Name:
0003-Fix-links-to-function-and-files.patch  Size: 2KiB   By: pbrais

<http://savannah.nongnu.org/patch/download.php?file_id=55501>
-------------------------------------------------------
Date: Mon 01 Jan 2024 10:59:02 PM UTC  Name:
0004-Use-typewriter-font-for-non-linked-files-and-paths.patch  Size: 2KiB  
By: pbrais

<http://savannah.nongnu.org/patch/download.php?file_id=55502>

    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/patch/?10422>

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