Apple-2-SW/contiki
1
0
Fork 0
mirror of https://github.com/oliverschmidt/contiki.git synced 2024-07-24 11:29:10 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #5 from malvira/codestyle-mention-indent

Browse Source 
Added a note about the Contiki code style GNU Indent script
This commit is contained in:
Adam Dunkels 2012-10-28 09:07:55 -07:00
commit 53f4d27af4
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/code-style.c
View File

@ -7,6 +7,16 @@
* belong to the same module. Typically, the \defgroup is placed in
* the .h file and \addtogroup in the .c file.
*
* The Contiki source code contains a GNU Indent script that can
* automatically format a C code file to match the Contiki code
* style. The Indent configuration is in contiki/tools/indent.pro and
* a small helper script is in contiki/tools/contiki-indent. Note that
* this is not a silver bullet - for example, the script does not add
* separators between functions, nor does it format comments
* correctly. The script should be treated as an aid in formatting
* code: first run the formatter on the source code, then manually
* edit the file.
*
* @{
*/
@ -14,7 +24,7 @@
* \file
* A brief description of what this file is.
* \author
* Adam Dunkels <adam@sics.se>
* Adam Dunkels <adam@dunkels.com>
*
* Every file that is part of a documented module has to have
* a \file block, else it will not show up in the Doxygen