65c029ccab7e93c75aae216e80ece5c948c625df
[alexxy/gromacs.git] / docs / dev-manual / style.md
1 Style guidelines {#page_devstyle}
2 ================
3
4  - \subpage page_devstyle_formatting <br/>
5    Guidelines for indentation and other code formatting.
6
7  - \subpage page_devstyle_includes <br/>
8    Guidelines for \#include style (ordering, paths to use, etc.).
9
10  - \subpage page_devstyle_naming <br/>
11    Naming conventions for files and various code constructs.
12
13  - [Doxygen guidelines](\ref section_doxygen_guidelines) <br/>
14    Guidelines for using Doxygen to document the source code are currently in a
15    section on the page on general Doxygen usage.
16
17 TODO: Add more guidelines