patchlwIP - A Lightweight TCP/IP stack - Patches: patch #10422, Improve doxygen documentation

 
 

You are not allowed to post comments on this tracker with your current authentication level.

patch #10422: Improve doxygen documentation

Submitter:  Philippe Brais <pbrais>
Submitted:  Mon 01 Jan 2024 10:59:02 PM UTC
   
 
Category:  Documentation Priority:  5 - Normal
Status:  None Privacy:  Public
Assigned to:  None Open/Closed:  Open
Planned Release:  None

Mon 01 Jan 2024 10:59:02 PM UTC, original submission:  

While reading the Doxygen documentation, I noticed in the page 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.

Philippe Brais <pbrais>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by pbrais (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2024-01-01 pbrais Attached File- Added 0001-Fix-typos.patch, #55499
        Attached File- Added 0002-Fix-code-block-indentation-in-bullet-point.patch, #55500
        Attached File- Added 0003-Fix-links-to-function-and-files.patch, #55501
        Attached File- Added 0004-Use-typewriter-font-for-non-linked-files-and-paths.patch, #55502

    Back to the top

    Powered by Savane 3.13-02a9.
    Corresponding source code