Updated File Header Structure and Includes (markdown) authored by williamfgc's avatar williamfgc
...@@ -26,7 +26,7 @@ ...@@ -26,7 +26,7 @@
#endif // end of ADIOS2_ENGINE_BP_BPFILEWRITER_H_ #endif // end of ADIOS2_ENGINE_BP_BPFILEWRITER_H_
</code></pre></li></ul></li></ol></li><li> </code></pre></li></ul></li></ol></li><li>
<strong>Include documentation:</strong> list header components used in the code if header is not self-explanatory<ul><li>Example:</li></ul><ol><li><ul><li><pre style="border: 0;"><code>//vector and map are self-explanatory, no comment needed <strong>Documented included headers:</strong> list header components used in the code if header is not self-explanatory<ul><li>Example:</li></ul><ol><li><ul><li><pre style="border: 0;"><code>//vector and map are self-explanatory, no comment needed
#include &lt;vector&gt; #include &lt;vector&gt;
#include &lt;utility&gt; //std::pair #include &lt;utility&gt; //std::pair
#include &lt;stdexcept&gt; //std::invalid_argument #include &lt;stdexcept&gt; //std::invalid_argument
... ...
......