205 lines
13 KiB
HTML
205 lines
13 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<!-- BEGIN opengraph metadata -->
|
||
|
|
<meta property="og:title" content="RenderD7" />
|
||
|
|
<meta property="og:image" content="https://repository-images.githubusercontent.com/348492097/4f16df80-88fb-11eb-9d31-4015ff22c452" />
|
||
|
|
<meta property="og:description" content="Custom CSS theme for doxygen html-documentation with lots of customization parameters." />
|
||
|
|
<meta property="og:url" content="https://jothepro.github.io/doxygen-awesome-css/" />
|
||
|
|
<!-- END opengraph metadata -->
|
||
|
|
<!-- BEGIN twitter metadata -->
|
||
|
|
<meta name="twitter:image:src" content="https://repository-images.githubusercontent.com/348492097/4f16df80-88fb-11eb-9d31-4015ff22c452" />
|
||
|
|
<meta name="twitter:title" content="RenderD7" />
|
||
|
|
<meta name="twitter:description" content="Custom CSS theme for doxygen html-documentation with lots of customization parameters." />
|
||
|
|
<!-- END twitter metadata -->
|
||
|
|
<title>Renderd7-nightly: MyLibrary::Example Class Reference</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<link rel="icon" type="image/svg+xml" href="logo.drawio.svg"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
||
|
|
<script type="text/javascript" src="toggle-alternative-theme.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
||
|
|
DoxygenAwesomeDarkModeToggle.init()
|
||
|
|
DoxygenAwesomeParagraphLink.init()
|
||
|
|
</script>
|
||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.js"></script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- https://tholman.com/github-corners/ -->
|
||
|
|
<a href="https://github.com/NPI-D7/RenderD7/" class="github-corner" title="View source on GitHub" target="_blank">
|
||
|
|
<svg viewBox="0 0 250 250" width="40" height="40" style="position: absolute; top: 0; border: 0; right: 0; z-index: 99;" aria-hidden="true">
|
||
|
|
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">Renderd7-nightly
|
||
|
|
 <span id="projectnumber">v0.7.0</span>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
||
|
|
</div><!-- top -->
|
||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
|
|
<div id="nav-tree">
|
||
|
|
<div id="nav-tree-contents">
|
||
|
|
<div id="nav-sync" class="sync"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
||
|
|
class="ui-resizable-handle">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
$(document).ready(function(){initNavTree('classMyLibrary_1_1Example.html',''); initResizable(); });
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="classMyLibrary_1_1Example-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">MyLibrary::Example Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><a class="el" href="classMyLibrary_1_1Example.html" title="Example class to demonstrate the features of the custom CSS.">Example</a> class to demonstrate the features of the custom CSS.
|
||
|
|
<a href="classMyLibrary_1_1Example.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <example.hpp></code></p>
|
||
|
|
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
||
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for MyLibrary::Example:</div>
|
||
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
||
|
|
</div>
|
||
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
||
|
|
<div class="center">
|
||
|
|
<img src="classMyLibrary_1_1Example.png" usemap="#MyLibrary::Example_map" alt=""/>
|
||
|
|
<map id="MyLibrary::Example_map" name="MyLibrary::Example_map">
|
||
|
|
<area href="classMyLibrary_1_1SubclassExample.html" title="some subclass" alt="MyLibrary::SubclassExample" shape="rect" coords="0,56,175,80"/>
|
||
|
|
</map>
|
||
|
|
</div></div>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a1c0046b0674eb4cad09c5d3e943912b8"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMyLibrary_1_1Example.html#a1c0046b0674eb4cad09c5d3e943912b8">test</a> (const std::string &test)</td></tr>
|
||
|
|
<tr class="memdesc:a1c0046b0674eb4cad09c5d3e943912b8"><td class="mdescLeft"> </td><td class="mdescRight">brief summary <a href="classMyLibrary_1_1Example.html#a1c0046b0674eb4cad09c5d3e943912b8">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a1c0046b0674eb4cad09c5d3e943912b8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p><a class="el" href="classMyLibrary_1_1Example.html" title="Example class to demonstrate the features of the custom CSS.">Example</a> class to demonstrate the features of the custom CSS. </p>
|
||
|
|
<dl class="section author"><dt>Author</dt><dd>jothepro </dd></dl>
|
||
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a1c0046b0674eb4cad09c5d3e943912b8"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1c0046b0674eb4cad09c5d3e943912b8">◆ </a></span>test()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::string MyLibrary::Example::test </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const std::string & </td>
|
||
|
|
<td class="paramname"><em>test</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>brief summary </p>
|
||
|
|
<p>doxygen test documentation</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">test</td><td>this is the only parameter of this test function. It does nothing!</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<h1><a class="anchor" id="autotoc_md0"></a>
|
||
|
|
Supported elements</h1>
|
||
|
|
<p>These elements have been tested with the custom CSS.</p>
|
||
|
|
<h2><a class="anchor" id="autotoc_md1"></a>
|
||
|
|
Tables</h2>
|
||
|
|
<p>The table content is scrollable if the table gets too wide.</p>
|
||
|
|
<table class="markdownTable">
|
||
|
|
<tr class="markdownTableHead">
|
||
|
|
<th class="markdownTableHeadNone">first_column </th><th class="markdownTableHeadNone">second_column </th><th class="markdownTableHeadNone">third_column </th><th class="markdownTableHeadNone">fourth_column </th><th class="markdownTableHeadNone">fifth_column </th><th class="markdownTableHeadNone">sixth_column </th><th class="markdownTableHeadNone">seventh_column </th><th class="markdownTableHeadNone">eighth_column </th><th class="markdownTableHeadNone">ninth_column </th></tr>
|
||
|
|
<tr class="markdownTableRowOdd">
|
||
|
|
<td class="markdownTableBodyNone">1 </td><td class="markdownTableBodyNone">2 </td><td class="markdownTableBodyNone">3 </td><td class="markdownTableBodyNone">4 </td><td class="markdownTableBodyNone">5 </td><td class="markdownTableBodyNone">6 </td><td class="markdownTableBodyNone">7 </td><td class="markdownTableBodyNone">8 </td><td class="markdownTableBodyNone">9 </td></tr>
|
||
|
|
</table>
|
||
|
|
<h2><a class="anchor" id="autotoc_md2"></a>
|
||
|
|
Lists</h2>
|
||
|
|
<ul>
|
||
|
|
<li>element 1</li>
|
||
|
|
<li>element 2</li>
|
||
|
|
</ul>
|
||
|
|
<ol type="1">
|
||
|
|
<li>element 1 <div class="fragment"><div class="line">code in lists</div>
|
||
|
|
</div><!-- fragment --></li>
|
||
|
|
<li>element 2</li>
|
||
|
|
</ol>
|
||
|
|
<h2><a class="anchor" id="autotoc_md3"></a>
|
||
|
|
Quotes</h2>
|
||
|
|
<blockquote class="doxtable">
|
||
|
|
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Velit sed ullamcorper morbi tincidunt ornare.</p>
|
||
|
|
<p>Lorem ipsum dolor sit amet consectetur adipiscing elit duis. </p>
|
||
|
|
</blockquote>
|
||
|
|
<p><em>- jothepro</em></p>
|
||
|
|
<h2><a class="anchor" id="autotoc_md4"></a>
|
||
|
|
Code block</h2>
|
||
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> x = <span class="stringliteral">"code within md fences (```)"</span>;</div>
|
||
|
|
</div><!-- fragment --><div class="fragment"><div class="line"><span class="comment">// code within @code block</span></div>
|
||
|
|
<div class="line"><span class="keywordflow">while</span>(<span class="keyword">true</span>) {</div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> example = std::make_shared<Example>(5);</div>
|
||
|
|
<div class="line"> example->test(<span class="stringliteral">"test"</span>);</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --> <pre class="fragment">// code within indented code block
|
||
|
|
auto test = std::shared_ptr<Example(5);
|
||
|
|
</pre><p>Inline <code>code</code> elements in a text. <em>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</em> This also works within multiline text and does not break the <code>layout</code>.</p>
|
||
|
|
<h2><a class="anchor" id="autotoc_md5"></a>
|
||
|
|
Special hints</h2>
|
||
|
|
<dl class="section warning"><dt>Warning</dt><dd>this is a warning only for demonstration purposes</dd></dl>
|
||
|
|
<dl class="section note"><dt>Note</dt><dd>this is a note to show that notes work. They can also include <code>code</code>: <div class="fragment"><div class="line"><span class="keywordtype">void</span> this_looks_awesome();</div>
|
||
|
|
</div><!-- fragment --></dd></dl>
|
||
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>example bug</dd></dl>
|
||
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>None of this will be deprecated, because it's beautiful!</dd></dl>
|
||
|
|
<dl class="section invariant"><dt>Invariant</dt><dd>This is an invariant</dd></dl>
|
||
|
|
<dl class="section pre"><dt>Precondition</dt><dd>This is a precondition</dd></dl>
|
||
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>This theme is never finished!</dd></dl>
|
||
|
|
<dl class="section remark"><dt>Remarks</dt><dd>This is awesome! </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><b>MyLibrary</b></li><li class="navelem"><a class="el" href="classMyLibrary_1_1Example.html">Example</a></li>
|
||
|
|
<li class="footer">Generated by
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|