archive/archived
Archived
1
0
Fork 0
Code Activity

docs/HACKING: correct formating on unordered lists.

Browse source
This commit is contained in:
Henrik Hautakoski 2011-03-24 08:12:15 +01:00
parent 12e2f62d6e
commit 3f4b9050dc
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/HACKING
View file

@ -79,13 +79,13 @@ a pointer to a struct list
Naming Naming
------ ------
* Never use CamelCase. UPPERCASE for constants and lowercase for variables,functions,macros. words is separated by underscore. - Never use CamelCase. UPPERCASE for constants and lowercase for variables,functions,macros. words is separated by underscore.
* API functions (that have a prototype in a header file) should be prefixed with the header filename. - API functions (that have a prototype in a header file) should be prefixed with the header filename.
One exception exist and that is when the functionality is realy lowlevel and/or generic enough that it One exception exist and that is when the functionality is realy lowlevel and/or generic enough that it
would be redundant to include a prefix. an example of this is a fatal() or die() function that may be prototyped in misc.h. would be redundant to include a prefix. an example of this is a fatal() or die() function that may be prototyped in misc.h.
* Headerguard defines is written like __PATH_TO_THIS_HEADER_H - Headerguard defines is written like __PATH_TO_THIS_HEADER_H
Documentation Documentation
------------- -------------