Repository: mesos-site Updated Branches: refs/heads/asf-site 6ba682f00 -> e87c75f8b
Updated the website built from mesos SHA: e757918. Project: http://git-wip-us.apache.org/repos/asf/mesos-site/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos-site/commit/e87c75f8 Tree: http://git-wip-us.apache.org/repos/asf/mesos-site/tree/e87c75f8 Diff: http://git-wip-us.apache.org/repos/asf/mesos-site/diff/e87c75f8 Branch: refs/heads/asf-site Commit: e87c75f8b0a3449b0bd07d37411e1917f670c68b Parents: 6ba682f Author: jenkins <[email protected]> Authored: Tue Oct 17 18:54:41 2017 +0000 Committer: jenkins <[email protected]> Committed: Tue Oct 17 18:54:41 2017 +0000 ---------------------------------------------------------------------- .../doxygen-style-guide/index.html | 77 ++++++-------------- .../latest/doxygen-style-guide/index.html | 77 ++++++-------------- 2 files changed, 48 insertions(+), 106 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos-site/blob/e87c75f8/content/documentation/doxygen-style-guide/index.html ---------------------------------------------------------------------- diff --git a/content/documentation/doxygen-style-guide/index.html b/content/documentation/doxygen-style-guide/index.html index 3267506..7c1ce94 100644 --- a/content/documentation/doxygen-style-guide/index.html +++ b/content/documentation/doxygen-style-guide/index.html @@ -131,13 +131,7 @@ enhanced by source code comments as appropriate, but these comments should not f <p>We follow the <a href="http://en.wikipedia.org/wiki/Javadoc";>Javadoc syntax</a> to mark comment blocks. These have the general form:</p> -<!-- NOTE: In order to show the comments as part of the code blocks in -this we must use indentation instead of fenced code blocks (i.e., -~~~{.cpp}) because doxygen will remove all of the comments and just -render the code. --> - - -<pre><code>/** +<pre><code class="cpp">/** * Brief summary. * * Detailed description. More detail. @@ -150,7 +144,7 @@ render the code. --> <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Returns a compressed version of a string. * * Compresses an input string using the foobar algorithm. @@ -158,7 +152,7 @@ render the code. --> * @param uncompressed The input string. * @return A compressed version of the input string. */ - std::string compress(const std::string& uncompressed); +std::string compress(const std::string& uncompressed); </code></pre> <h3>Doxygen Tags</h3> @@ -166,15 +160,15 @@ render the code. --> <p>This is the allowed set of doxygen tags that can be used.</p> <ul> -<li><a href="http://doxygen.org/manual/commands.html#cmdparam";>\@param</a> Describes function parameters.</li> -<li><a href="http://doxygen.org/manual/commands.html#cmdreturn";>\@return</a> Describes return values.</li> -<li><a href="http://doxygen.org/manual/commands.html#cmdsa";>\@see</a> Describes a cross-reference to classes, functions, methods, variables, files or URL.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdparam";><code>@param</code></a> Describes function parameters.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdreturn";><code>@return</code></a> Describes return values.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdsa";><code>@see</code></a> Describes a cross-reference to classes, functions, methods, variables, files or URL.</li> </ul> <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Available kinds of implementations. * * @see process::network::PollSocketImpl @@ -182,28 +176,31 @@ render the code. --> </code></pre> <ul> -<li><a href="http://doxygen.org/manual/commands.html#cmdfile";>\@file</a> Describes a refence to a file. It is required when documenting global functions, variables, typedefs, or enums in separate files.</li> -<li><a href="http://doxygen.org/manual/commands.html#cmdlink";>\@link</a> and <a href="http://doxygen.org/manual/commands.html#cmdendlink";>\@endlink</a> Describes a link to a file, class, or member.</li> -<li><a href="http://doxygen.org/manual/commands.html#cmdexample";>\@example</a> Describes source code examples.</li> -<li><p><a href="http://doxygen.org/manual/commands.html#cmdimage";>\@image</a> Describes an image.</p></li> -<li><p>When following these links be aware that the doxygen documentation is using another syntax in that \@param is explained as \param.</p></li> +<li><a href="http://doxygen.org/manual/commands.html#cmdfile";><code>@file</code></a> Describes a refence to a file. It is required when documenting global functions, variables, typedefs, or enums in separate files.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdlink";><code>@link</code></a> and <a href="http://doxygen.org/manual/commands.html#cmdendlink";><code>@endlink</code></a> Describes a link to a file, class, or member.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdexample";><code>@example</code></a> Describes source code examples.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdimage";><code>@image</code></a> Describes an image.</li> </ul> +<blockquote><p>When following these links be aware that the Doxygen documentation uses the <code>\param</code> syntax rather than <code>@param</code>.</p></blockquote> + <h3>Wrapping</h3> -<p>We wrap long descriptions using four spaces on the next line.</p> +<p>We wrap long descriptions using four spaces on the next line:</p> -<pre><code>@param uncompressed The input string that requires - a very long description and an even longer - description on this line as well. +<pre><code class="cpp">/** + * @param uncompressed The input string that requires + * a very long description and an even longer + * description on this line as well. + */ </code></pre> <h3>Constants and Variables</h3> <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Prefix used to name Docker containers in order to distinguish * those created by Mesos from those created manually. */ @@ -214,7 +211,7 @@ extern const std::string DOCKER_NAME_PREFIX; <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * The parent side of the pipe for stdin. * If the mode is not PIPE, None will be stored. * **NOTE**: stdin is a macro on some systems, hence this name instead. @@ -226,7 +223,7 @@ Option<int> in; <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Forks a subprocess and execs the specified 'path' with the * specified 'argv', redirecting stdin, stdout, and stderr as * specified by 'in', 'out', and 'err' respectively. @@ -269,7 +266,7 @@ Try<Subprocess> subprocess( <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Represents a fork() exec()ed subprocess. Access is provided to the * input / output of the process, as well as the exit status. The * input / output file descriptors are only closed after: @@ -282,35 +279,9 @@ class Subprocess public: </code></pre> -<h2>Library and Component Overview Pages and Developer Guides</h2> - -<p>Substantial libraries, components, and subcomponents of the Mesos system such as -stout, libprocess, master, agent, containerizer, allocator, and others -should have an overview page in markdown format that explains their -purpose, overall structure, and general use. This can even be a complete developer guide.</p> - -<p>This page must be located in the top directory of the library/component and named “README.md”.</p> - -<p>The first line in such a document must be a section heading bearing the title which will appear in the generated Doxygen index. -Example: “# Libprocess Developer Guide”</p> - -<h3>Example Code</h3> - -<p>C++ code examples should be enclosed by ‘~~~{.cpp}’.</p> - -<p>Example:</p> - -<pre><code class="{.cpp}">int main(int argc, char** argv) -{ - ... -} -</code></pre> - -<p><strong>NOTE</strong>: Because of shortcomings of Doxygen’s markdown parser we currently use indentation for wrapping all non C++ code blocks.</p> - <h2>Building Doxygen Documentation</h2> -<p>As of right now, the Doxygen documentation should be built from the <em>build</em> subdirectory using <em>doxygen ../Doxyfile</em> . The documentation will then be generated into the <em>./doxygen</em> subdirectory.</p> +<p>As of right now, the Doxygen documentation should be built from the <em>build</em> subdirectory using <code>doxygen ../Doxyfile</code>. The documentation will then be generated into the <code>./doxygen</code> subdirectory.</p> </div> </div> http://git-wip-us.apache.org/repos/asf/mesos-site/blob/e87c75f8/content/documentation/latest/doxygen-style-guide/index.html ---------------------------------------------------------------------- diff --git a/content/documentation/latest/doxygen-style-guide/index.html b/content/documentation/latest/doxygen-style-guide/index.html index 81ba57b..a6245e2 100644 --- a/content/documentation/latest/doxygen-style-guide/index.html +++ b/content/documentation/latest/doxygen-style-guide/index.html @@ -131,13 +131,7 @@ enhanced by source code comments as appropriate, but these comments should not f <p>We follow the <a href="http://en.wikipedia.org/wiki/Javadoc";>Javadoc syntax</a> to mark comment blocks. These have the general form:</p> -<!-- NOTE: In order to show the comments as part of the code blocks in -this we must use indentation instead of fenced code blocks (i.e., -~~~{.cpp}) because doxygen will remove all of the comments and just -render the code. --> - - -<pre><code>/** +<pre><code class="cpp">/** * Brief summary. * * Detailed description. More detail. @@ -150,7 +144,7 @@ render the code. --> <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Returns a compressed version of a string. * * Compresses an input string using the foobar algorithm. @@ -158,7 +152,7 @@ render the code. --> * @param uncompressed The input string. * @return A compressed version of the input string. */ - std::string compress(const std::string& uncompressed); +std::string compress(const std::string& uncompressed); </code></pre> <h3>Doxygen Tags</h3> @@ -166,15 +160,15 @@ render the code. --> <p>This is the allowed set of doxygen tags that can be used.</p> <ul> -<li><a href="http://doxygen.org/manual/commands.html#cmdparam";>\@param</a> Describes function parameters.</li> -<li><a href="http://doxygen.org/manual/commands.html#cmdreturn";>\@return</a> Describes return values.</li> -<li><a href="http://doxygen.org/manual/commands.html#cmdsa";>\@see</a> Describes a cross-reference to classes, functions, methods, variables, files or URL.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdparam";><code>@param</code></a> Describes function parameters.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdreturn";><code>@return</code></a> Describes return values.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdsa";><code>@see</code></a> Describes a cross-reference to classes, functions, methods, variables, files or URL.</li> </ul> <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Available kinds of implementations. * * @see process::network::PollSocketImpl @@ -182,28 +176,31 @@ render the code. --> </code></pre> <ul> -<li><a href="http://doxygen.org/manual/commands.html#cmdfile";>\@file</a> Describes a refence to a file. It is required when documenting global functions, variables, typedefs, or enums in separate files.</li> -<li><a href="http://doxygen.org/manual/commands.html#cmdlink";>\@link</a> and <a href="http://doxygen.org/manual/commands.html#cmdendlink";>\@endlink</a> Describes a link to a file, class, or member.</li> -<li><a href="http://doxygen.org/manual/commands.html#cmdexample";>\@example</a> Describes source code examples.</li> -<li><p><a href="http://doxygen.org/manual/commands.html#cmdimage";>\@image</a> Describes an image.</p></li> -<li><p>When following these links be aware that the doxygen documentation is using another syntax in that \@param is explained as \param.</p></li> +<li><a href="http://doxygen.org/manual/commands.html#cmdfile";><code>@file</code></a> Describes a refence to a file. It is required when documenting global functions, variables, typedefs, or enums in separate files.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdlink";><code>@link</code></a> and <a href="http://doxygen.org/manual/commands.html#cmdendlink";><code>@endlink</code></a> Describes a link to a file, class, or member.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdexample";><code>@example</code></a> Describes source code examples.</li> +<li><a href="http://doxygen.org/manual/commands.html#cmdimage";><code>@image</code></a> Describes an image.</li> </ul> +<blockquote><p>When following these links be aware that the Doxygen documentation uses the <code>\param</code> syntax rather than <code>@param</code>.</p></blockquote> + <h3>Wrapping</h3> -<p>We wrap long descriptions using four spaces on the next line.</p> +<p>We wrap long descriptions using four spaces on the next line:</p> -<pre><code>@param uncompressed The input string that requires - a very long description and an even longer - description on this line as well. +<pre><code class="cpp">/** + * @param uncompressed The input string that requires + * a very long description and an even longer + * description on this line as well. + */ </code></pre> <h3>Constants and Variables</h3> <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Prefix used to name Docker containers in order to distinguish * those created by Mesos from those created manually. */ @@ -214,7 +211,7 @@ extern const std::string DOCKER_NAME_PREFIX; <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * The parent side of the pipe for stdin. * If the mode is not PIPE, None will be stored. * **NOTE**: stdin is a macro on some systems, hence this name instead. @@ -226,7 +223,7 @@ Option<int> in; <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Forks a subprocess and execs the specified 'path' with the * specified 'argv', redirecting stdin, stdout, and stderr as * specified by 'in', 'out', and 'err' respectively. @@ -269,7 +266,7 @@ Try<Subprocess> subprocess( <p>Example:</p> -<pre><code>/** +<pre><code class="cpp">/** * Represents a fork() exec()ed subprocess. Access is provided to the * input / output of the process, as well as the exit status. The * input / output file descriptors are only closed after: @@ -282,35 +279,9 @@ class Subprocess public: </code></pre> -<h2>Library and Component Overview Pages and Developer Guides</h2> - -<p>Substantial libraries, components, and subcomponents of the Mesos system such as -stout, libprocess, master, agent, containerizer, allocator, and others -should have an overview page in markdown format that explains their -purpose, overall structure, and general use. This can even be a complete developer guide.</p> - -<p>This page must be located in the top directory of the library/component and named “README.md”.</p> - -<p>The first line in such a document must be a section heading bearing the title which will appear in the generated Doxygen index. -Example: “# Libprocess Developer Guide”</p> - -<h3>Example Code</h3> - -<p>C++ code examples should be enclosed by ‘~~~{.cpp}’.</p> - -<p>Example:</p> - -<pre><code class="{.cpp}">int main(int argc, char** argv) -{ - ... -} -</code></pre> - -<p><strong>NOTE</strong>: Because of shortcomings of Doxygen’s markdown parser we currently use indentation for wrapping all non C++ code blocks.</p> - <h2>Building Doxygen Documentation</h2> -<p>As of right now, the Doxygen documentation should be built from the <em>build</em> subdirectory using <em>doxygen ../Doxyfile</em> . The documentation will then be generated into the <em>./doxygen</em> subdirectory.</p> +<p>As of right now, the Doxygen documentation should be built from the <em>build</em> subdirectory using <code>doxygen ../Doxyfile</code>. The documentation will then be generated into the <code>./doxygen</code> subdirectory.</p> </div> </div>
