mirror of
https://github.com/oliverschmidt/contiki.git
synced 2024-08-28 07:28:58 +00:00
Merge pull request #5 from malvira/codestyle-mention-indent
Added a note about the Contiki code style GNU Indent script
This commit is contained in:
commit
53f4d27af4
@ -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
|
||||||
|
Loading…
Reference in New Issue
Block a user