sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update comments; trivial addtion to a document.

Browse Source
This commit is contained in:
Gregory Nutt 2016-06-10 09:36:23 -06:00
parent b275604eab
commit c98f00a93b
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/NuttXCCodingStandard.html
View File

@ -162,10 +162,10 @@
Pre-processor Definitions
</li>
<li>
Private Types
Private Types (definitions)
</li>
<li>
Private Function Prototypes
Private Function Prototypes (declarations)
</li>
<li>
Private Data (definitions)
@ -191,7 +191,7 @@
Pre-processor Definitions
</li>
<li>
Public Types
Public Types (definitions)
</li>
<li>
Public Data (declarations)
@ -212,12 +212,12 @@
</p>
<p>
<a name="idempotence"><b>Header File Idempotence</b></a>.
C header file must protect against multipleinclusion through the use of macros that &quot;guard&quot; against multiple definitions if the header file is included multiple times.
C header file must protect against multiple inclusion through the use of macros that &quot;guard&quot; against multiple definitions if the header file is included multiple times.
</p>
<ul>
<li>
<p>
Each header file must contain the following pre-processor commands near the beginning of the header file: Between the file header and the &quot;Included Files&quot; block comment.
Each header file must contain the following pre-processor conditional logic near the beginning of the header file: Between the file header and the &quot;Included Files&quot; block comment.
For example,
</p>
<ul><pre>

6
net/tcp/tcp_input.c
View File

@ -71,9 +71,9 @@
* Handle incoming TCP input
*
* Parameters:
* dev - The device driver structure containing the received TCP packet.
* tcp - A pointer to the TCP header in the packet
* tcpiplen - Combined length of the IP and TCP headers
* dev - The device driver structure containing the received TCP packet.
* tcp - A pointer to the TCP header in the packet
* iplen - Combined length of the IP and TCP headers
*
* Return:
* None

6
net/udp/udp_input.c
View File

@ -67,9 +67,9 @@
* Handle incoming UDP input
*
* Parameters:
* dev - The device driver structure containing the received UDP packet
* udp - A pointer to the UDP header in the packet
* udpiplen - Length of the IP and UDP headers
* dev - The device driver structure containing the received UDP packet
* udp - A pointer to the UDP header in the packet
* iplen - Length of the IP and UDP headers
*
* Return:
* OK The packet has been processed and can be deleted