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 @ 351d1422
......@@ -24,7 +24,7 @@
#include <utility> //std::pair
#include <stdexcept> //std::invalid_argument
#include <map>
</code></pre></li></ul></li></ol></li></ol>
</code></pre></li></ul></li></ol></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
......@@ -34,4 +34,5 @@
</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>
\ No newline at end of file
</code></pre></li></ul></li>
</ol>
\ No newline at end of file