Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-06-06 00:14:22 +08:00
Code Issues Actions 1 Packages Projects 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
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/NuttXCCodingStandard.html
+5 -5
View File
@@ -162,10 +162,10 @@
Pre-processor Definitions Pre-processor Definitions
</li> </li>
<li> <li>
Private Types Private Types (definitions)
</li> </li>
<li> <li>
Private Function Prototypes Private Function Prototypes (declarations)
</li> </li>
<li> <li>
Private Data (definitions) Private Data (definitions)
@@ -191,7 +191,7 @@
Pre-processor Definitions Pre-processor Definitions
</li> </li>
<li> <li>
Public Types Public Types (definitions)
</li> </li>
<li> <li>
Public Data (declarations) Public Data (declarations)
@@ -212,12 +212,12 @@
</p> </p>
<p> <p>
<a name="idempotence"><b>Header File Idempotence</b></a>. <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> </p>
<ul> <ul>
<li> <li>
<p> <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, For example,
</p> </p>
<ul><pre> <ul><pre>
net/tcp/tcp_input.c
+1 -1
View File
@@ -73,7 +73,7 @@
* Parameters: * Parameters:
* dev - The device driver structure containing the received TCP packet. * dev - The device driver structure containing the received TCP packet.
* tcp - A pointer to the TCP header in the packet * tcp - A pointer to the TCP header in the packet
* tcpiplen - Combined length of the IP and TCP headers * iplen - Combined length of the IP and TCP headers
* *
* Return: * Return:
* None * None
net/udp/udp_input.c
+1 -1
View File
@@ -69,7 +69,7 @@
* Parameters: * Parameters:
* dev - The device driver structure containing the received UDP packet * dev - The device driver structure containing the received UDP packet
* udp - A pointer to the UDP header in the packet * udp - A pointer to the UDP header in the packet
* udpiplen - Length of the IP and UDP headers * iplen - Length of the IP and UDP headers
* *
* Return: * Return:
* OK The packet has been processed and can be deleted * OK The packet has been processed and can be deleted