deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Added a note about the Contiki code style GNU Indent script

Browse source
This commit is contained in:
Adam Dunkels 2012-10-28 16:03:59 +01:00 committed by Mariano Alvira
parent 6f1eb21865
commit c9bd23515a
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 * belong to the same module. Typically, the \defgroup is placed in
* the .h file and \addtogroup in the .c file. * 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 * \file
* A brief description of what this file is. * A brief description of what this file is.
* \author * \author
* Adam Dunkels <adam@sics.se> * Adam Dunkels <adam@dunkels.com>
* *
* Every file that is part of a documented module has to have * Every file that is part of a documented module has to have
* a \file block, else it will not show up in the Doxygen * a \file block, else it will not show up in the Doxygen