Skip to content

Changes

Page history
Updated File Header Structure and Includes (markdown) authored by williamfgc's avatar williamfgc
Hide whitespace changes
Inline Side-by-side
File-Header-Structure-and-Includes.md
View page @ f78fe094
1. <strong>License header:</strong> All files start with the ADIOS2 Apache license header, file name, creation date, and author's name. Contact information is encouraged. 1. <strong>License header:</strong> All files start with the ADIOS2 Apache license header, file name, creation date, and author's name. Contact information is encouraged.
```cpp ```cpp
<strong>
/* /*
* Distributed under the OSI-approved Apache License, Version 2.0. See * Distributed under the OSI-approved Apache License, Version 2.0. See
* accompanying file Copyright.txt for details. * accompanying file Copyright.txt for details.
...@@ -9,6 +10,7 @@ ...@@ -9,6 +10,7 @@
* Created on: April 27, 2017 * Created on: April 27, 2017
* Author: Mark Alexander Godoy godoyma@email.com * Author: Mark Alexander Godoy godoyma@email.com
*/ */
</strong>
``` ```
2. <strong>Header files include guards:</strong> all header files must have include guards to prevent name conflict. These are place right after the license and at the end of the file. The adopted format includes the relative path in ADIOS. For example, file _adios2/engine/bp/BPFileWriter.h_ will contain the following include guards: 2. <strong>Header files include guards:</strong> all header files must have include guards to prevent name conflict. These are place right after the license and at the end of the file. The adopted format includes the relative path in ADIOS. For example, file _adios2/engine/bp/BPFileWriter.h_ will contain the following include guards:
......