mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-12-23 21:14:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added source code self documentation guidelines.

Browse Source
This commit is contained in:
likewise 2003-04-01 13:34:56 +00:00
parent a28af1be11
commit 132b09ce09
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/contrib.txt
View File

@ -6,14 +6,22 @@ First of all as you may already know lwIP is a volunteer project so feedback
to fixes or questions might often come late. Hopefully the bug and patch tracking
features of Savannah help us not lose users' input.
Source code style:
- end debug messages with a newline (\n)
- indentation is two spaces per level, no tabs.
- end debug messages with a trailing newline (\n).
- no space between function and opening bracket.
- one space between keyword and opening bracket.
- one space and no newline before opening curly braces.
- spaces surrounding assignment and comparisons.
- use current source code style as further reference.
Source code self documentation style:
- JavaDoc compliant and Doxygen compatible.
- Function documentation above functions in .c files, not .h files.
- Use current documentation style as further reference.
Bug reports and patches:
- Make sure you are reporting bugs or send patches against the latest sources.That usually means code in CVS