Skip to content

Commit 575f489

Browse files
Fixing documentation errors
Minor errors in the documentation were fixed. These caused failure of the doxygen checks in the PR.
1 parent c3d16f7 commit 575f489

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

connectivity/netsocket/include/netsocket/MsgHeader.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,10 @@
3838
} nsapi_pktinfo_t;
3939
* @endcode
4040
*
41-
* There are two requirements for such structs to work well with MsgHeaderIterator:
42-
* first element needs to of type nsapi_msghdr_t
43-
* value of the field len of the nsapi_msghdr_t needs to bet set to the size of the whole extending type. For example:
41+
* There are two requirements for such structures to work well with MsgHeaderIterator.
42+
* - First element needs to be of type nsapi_msghdr_t.
43+
* - Value of the field len of the nsapi_msghdr_t needs to bet set to the size of the whole extending type.
44+
* For example:
4445
*
4546
* @code
4647
nsapi_pktinfo_t pkt_info;
@@ -54,7 +55,6 @@
5455
* Code presenting minimal usage example.
5556
*
5657
* @code
57-
*
5858
struct default_buffer_t {
5959
default_buffer_t()
6060
{
@@ -84,8 +84,8 @@
8484
auto p5 = it.next() // returns nullptr
8585
* @endcode
8686
*
87-
* @note More usage examples are implemented in the `MsgHeaderIterator` unit test
88-
* in `netsocket/tests/UNITTESTS/NetworkStack/test_MsgHeaderIterator.cpp`
87+
* @note More usage examples are implemented in the MsgHeaderIterator unit test
88+
* in netsocket/tests/UNITTESTS/NetworkStack/test_MsgHeaderIterator.cpp
8989
*/
9090

9191
struct MsgHeaderIterator {

0 commit comments

Comments
 (0)