File-Header-Structure-and-Includes.md

@@ -7,15 +7,6 @@
  *  Created on: April 27, 2017
  *      Author: Mark Alexander Godoy  godoyma@email.com
  */
- </code></pre></li></ul></li><li><strong>Header include organization:</strong> Example for file  ClassName.cpp  :<ol><li>Corresponding header:  ClassName.h </li><li>System C/POSIX Headers <em>e.g.</em> unistd.h, sys/ipc.h</li><li>C++ versions of system C headers <em>e.g.</em> cstdlib, cstring</li><li>System C++ headers  <em>e.g.</em> vector, map</li><li>Other library headers <em>e.g.</em> boost, zfp, bzip2, thrust</li><li>Other headers from this library <em>e.g</em> &quot;adiosFunctions.h&quot;</li></ol><ul><li>Example:</li></ul><ol><li><ul><li><pre style="border: 0;"><code> #include   &quot;ClassName.h&quot; 
-</code></pre></li><li><pre style="border: 0;"><code> #include   &lt;unistd.h&gt;     // write, close  
- #include   &lt;sys/ipc.h&gt;     // key_t  
-</code></pre></li><li><pre style="border: 0;"><code> #include   &lt;vector&gt; 
- #include   &lt;new&gt;     // std::bad_alloc  
-</code></pre></li><li><pre style="border: 0;"><code> #include   &lt;bzip2.h&gt; 
- #include   &lt;zfp.h&gt; 
-</code></pre></li><li><pre style="border: 0;"><code> #include   &quot;adiosFunctions.h&quot;     // IsLittleEndian  
-</code></pre></li></ul></li></ol></li><li>
 
 <strong>Include guards:</strong> all headers must have include guards to prevents 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, **adios2/engine/bp/BPFileWriter.h**  will contain the following include guards:<ol><li><ul><li><pre style="border: 0;"><code>#ifndef  ADIOS2_ENGINE_BP_BPFILEWRITER_H_
  #define  ADIOS2_ENGINE_BP_BPFILEWRITER_H_<br><br>
@@ -31,4 +22,14 @@
  #include   &lt;utility&gt;    //std::pair  
  #include   &lt;stdexcept&gt;  //std::invalid_argument  
  #include   &lt;map&gt;    
-</code></pre></li></ul></li></ol></li></ol>
\ No newline at end of file
+</code></pre></li></ul></li></ol></li></ol>
+
+ </code></pre></li></ul></li><li><strong>Header include organization:</strong> Use the following ordering for the included headers: Example for file  ClassName.cpp  :<ol><li>Corresponding header:  ClassName.h </li><li>System C/POSIX Headers <em>e.g.</em> unistd.h, sys/ipc.h</li><li>C++ versions of system C headers <em>e.g.</em> cstdlib, cstring</li><li>System C++ headers  <em>e.g.</em> vector, map</li><li>Other library headers <em>e.g.</em> boost, zfp, bzip2, thrust</li><li>Other headers from this library <em>e.g</em> &quot;adiosFunctions.h&quot;</li></ol><ul><li>Example:</li></ul><ol><li><ul><li><pre style="border: 0;"><code> #include   &quot;ClassName.h&quot; 
+</code></pre></li><li><pre style="border: 0;"><code> #include   &lt;unistd.h&gt;     // write, close  
+ #include   &lt;sys/ipc.h&gt;     // key_t  
+</code></pre></li><li><pre style="border: 0;"><code> #include   &lt;vector&gt; 
+ #include   &lt;new&gt;     // std::bad_alloc  
+</code></pre></li><li><pre style="border: 0;"><code> #include   &lt;bzip2.h&gt; 
+ #include   &lt;zfp.h&gt; 
+</code></pre></li><li><pre style="border: 0;"><code> #include   &quot;adiosFunctions.h&quot;     // IsLittleEndian  
+</code></pre></li></ul></li></ol></li><li>
\ No newline at end of file