Skip to content

Commit e27f330

Browse files
Auto update docs
1 parent a7661d3 commit e27f330

File tree

242 files changed

+24212
-857
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

242 files changed

+24212
-857
lines changed

Doxyfile

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ PROJECT_LOGO = favicon.ico
6868
# entered, it will be relative to the location where doxygen was started. If
6969
# left blank the current directory will be used.
7070

71-
OUTPUT_DIRECTORY = MeshLib/dev/Main
71+
OUTPUT_DIRECTORY = MeshLib/Main
7272

7373
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
7474
# sub-directories (in 2 levels) under the output directory of each output format
@@ -2437,8 +2437,7 @@ SKIP_FUNCTION_MACROS = YES
24372437
# the path). If a tag file is not located in the directory in which doxygen is
24382438
# run, you must also specify the path to the tagfile here.
24392439

2440-
TAGFILES = MeshLibCpp/MeshLibCpp.tag=../../MeshLibCpp/html \
2441-
MeshLibPy/MeshLibPy.tag=../../MeshLibPy/html
2440+
TAGFILES = MeshLib/MeshLibCpp.tag=../../MeshLib/Cpp/html MeshLib/MeshLibPy.tag=../../MeshLib/Py/html
24422441

24432442
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
24442443
# tag file that is based on the input files it reads. See section "Linking to

Doxyfile.bak

Lines changed: 2833 additions & 0 deletions
Large diffs are not rendered by default.

DoxyfileMain

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ PROJECT_LOGO = favicon.ico
6868
# entered, it will be relative to the location where doxygen was started. If
6969
# left blank the current directory will be used.
7070

71-
OUTPUT_DIRECTORY = MeshLib/Main
71+
OUTPUT_DIRECTORY = MeshLib/dev/Main
7272

7373
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
7474
# sub-directories (in 2 levels) under the output directory of each output format
@@ -1319,7 +1319,7 @@ HTML_FILE_EXTENSION = .html
13191319
# of the possible markers and block names see the documentation.
13201320
# This tag requires that the tag GENERATE_HTML is set to YES.
13211321

1322-
HTML_HEADER =
1322+
HTML_HEADER = html_header.html
13231323

13241324
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
13251325
# generated HTML page. If the tag is left blank doxygen will generate a standard

MeshLib/dev/Main/html/BasedApplication.html

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -146,31 +146,47 @@
146146
</div><!--header-->
147147
<div class="contents">
148148
<div class="textblock"><div class="tabbed"></div><div class="tabbed"><ul>
149-
<li><b class="tab-title">C++</b> First of all you should make <code>main</code> function like this <div class="fragment"><div class="line"><span class="preprocessor">#include &lt;MRMesh/MRLog.h&gt;</span></div>
150-
<div class="line"><span class="preprocessor">#include &lt;MRMesh/MRSystem.h&gt;</span></div>
151-
<div class="line"><span class="preprocessor">#include &lt;MRViewer/MRSetupViewer.h&gt;</span></div>
152-
<div class="line"><span class="preprocessor">#include &lt;MRViewer/MRViewer.h&gt;</span></div>
149+
<li><b class="tab-title">C++</b> First of all you should make <code>main</code> function like this <div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="codeRef" href="../../MeshLib/Cpp/html/MRLog_8h.html">MRMesh/MRLog.h</a>&gt;</span></div>
150+
<div class="line"><span class="preprocessor">#include &lt;<a class="codeRef" href="../../MeshLib/Cpp/html/MRSystem_8h.html">MRMesh/MRSystem.h</a>&gt;</span></div>
151+
<div class="line"><span class="preprocessor">#include &lt;<a class="codeRef" href="../../MeshLib/Cpp/html/MRSetupViewer_8h.html">MRViewer/MRSetupViewer.h</a>&gt;</span></div>
152+
<div class="line"><span class="preprocessor">#include &lt;<a class="codeRef" href="../../MeshLib/Cpp/html/MRViewer_8h.html">MRViewer/MRViewer.h</a>&gt;</span></div>
153153
<div class="line"> </div>
154154
<div class="line"><span class="keywordtype">int</span> <a class="code hl_function" href="MeshBoolean_8dox_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>( <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv )</div>
155155
<div class="line">{</div>
156-
<div class="line"> MR::setupLoggerByDefault();</div>
156+
<div class="line"> <a class="code hl_functionRef" href="../../MeshLib/Cpp/html/namespaceMR.html#a6804a7415d5f018fa64bf1b533af3d4f">MR::setupLoggerByDefault</a>();</div>
157157
<div class="line"> </div>
158158
<div class="line"> <span class="comment">// Init the viewer</span></div>
159159
<div class="line"> </div>
160-
<div class="line"> MR::Viewer::LaunchParams launchParams{ .argc = argc, .argv = argv };</div>
161-
<div class="line"> MR::Viewer::parseLaunchParams( launchParams );</div>
160+
<div class="line"> <a class="code hl_structRef" href="../../MeshLib/Cpp/html/structMR_1_1LaunchParams.html">MR::Viewer::LaunchParams</a> launchParams{ .<a class="code hl_variableRef" href="../../MeshLib/Cpp/html/structMR_1_1LaunchParams.html#a25346cad277e065c937a564b8b5f003d">argc</a> = argc, .argv = argv };</div>
161+
<div class="line"> <a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1Viewer.html#a26632c3fff60e6f927d932d86503aa8f">MR::Viewer::parseLaunchParams</a>( launchParams );</div>
162162
<div class="line"> launchParams.name = <span class="stringliteral">&quot;Your app name&quot;</span>;</div>
163163
<div class="line"> </div>
164-
<div class="line"> MR::ViewerSetup viewerSetup;</div>
165-
<div class="line"> viewerSetup.setupBasePlugins( MR::Viewer::instance() );</div>
166-
<div class="line"> viewerSetup.setupCommonModifiers( MR::Viewer::instance() );</div>
167-
<div class="line"> viewerSetup.setupCommonPlugins( MR::Viewer::instance() );</div>
168-
<div class="line"> viewerSetup.setupSettingsManager( MR::Viewer::instance(), launchParams.name );</div>
169-
<div class="line"> viewerSetup.setupConfiguration( MR::Viewer::instance() );</div>
164+
<div class="line"> <a class="code hl_classRef" href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html">MR::ViewerSetup</a> viewerSetup;</div>
165+
<div class="line"> viewerSetup.<a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a68075c17440a99ede74249da2ff6ecd9">setupBasePlugins</a>( <a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1Viewer.html#a827107af544bf966370dc8de607ed59c">MR::Viewer::instance</a>() );</div>
166+
<div class="line"> viewerSetup.<a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a66bb762d87286ae7b094f6a59bb96aec">setupCommonModifiers</a>( <a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1Viewer.html#a827107af544bf966370dc8de607ed59c">MR::Viewer::instance</a>() );</div>
167+
<div class="line"> viewerSetup.<a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a04abb25fb543f1b7f29d33eed34bdb81">setupCommonPlugins</a>( <a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1Viewer.html#a827107af544bf966370dc8de607ed59c">MR::Viewer::instance</a>() );</div>
168+
<div class="line"> viewerSetup.<a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a9ba29b362190cbfc386b59d8051f8b06">setupSettingsManager</a>( <a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1Viewer.html#a827107af544bf966370dc8de607ed59c">MR::Viewer::instance</a>(), launchParams.name );</div>
169+
<div class="line"> viewerSetup.<a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a918f69117bd46f408fda277cad5fde2d">setupConfiguration</a>( <a class="code hl_functionRef" href="../../MeshLib/Cpp/html/classMR_1_1Viewer.html#a827107af544bf966370dc8de607ed59c">MR::Viewer::instance</a>() );</div>
170170
<div class="line"> </div>
171-
<div class="line"> <span class="keywordflow">return</span> MR::launchDefaultViewer( launchParams, viewerSetup );</div>
171+
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_functionRef" href="../../MeshLib/Cpp/html/namespaceMR.html#abf0f4c580a56e4a7e297faa1b6de7378">MR::launchDefaultViewer</a>( launchParams, viewerSetup );</div>
172172
<div class="line">}</div>
173+
<div class="ttc" id="aMRLog_8h_html"><div class="ttname"><a href="../../MeshLib/Cpp/html/MRLog_8h.html">MRLog.h</a></div></div>
174+
<div class="ttc" id="aMRSetupViewer_8h_html"><div class="ttname"><a href="../../MeshLib/Cpp/html/MRSetupViewer_8h.html">MRSetupViewer.h</a></div></div>
175+
<div class="ttc" id="aMRSystem_8h_html"><div class="ttname"><a href="../../MeshLib/Cpp/html/MRSystem_8h.html">MRSystem.h</a></div></div>
176+
<div class="ttc" id="aMRViewer_8h_html"><div class="ttname"><a href="../../MeshLib/Cpp/html/MRViewer_8h.html">MRViewer.h</a></div></div>
173177
<div class="ttc" id="aMeshBoolean_8dox_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="MeshBoolean_8dox_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition</b> MeshBoolean.dox.cpp:8</div></div>
178+
<div class="ttc" id="aclassMR_1_1ViewerSetup_html"><div class="ttname"><a href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html">MR::ViewerSetup</a></div></div>
179+
<div class="ttc" id="aclassMR_1_1ViewerSetup_html_a04abb25fb543f1b7f29d33eed34bdb81"><div class="ttname"><a href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a04abb25fb543f1b7f29d33eed34bdb81">MR::ViewerSetup::setupCommonPlugins</a></div><div class="ttdeci">virtual void setupCommonPlugins(Viewer *) const</div></div>
180+
<div class="ttc" id="aclassMR_1_1ViewerSetup_html_a66bb762d87286ae7b094f6a59bb96aec"><div class="ttname"><a href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a66bb762d87286ae7b094f6a59bb96aec">MR::ViewerSetup::setupCommonModifiers</a></div><div class="ttdeci">virtual void setupCommonModifiers(Viewer *) const</div></div>
181+
<div class="ttc" id="aclassMR_1_1ViewerSetup_html_a68075c17440a99ede74249da2ff6ecd9"><div class="ttname"><a href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a68075c17440a99ede74249da2ff6ecd9">MR::ViewerSetup::setupBasePlugins</a></div><div class="ttdeci">virtual MRVIEWER_API void setupBasePlugins(Viewer *) const</div></div>
182+
<div class="ttc" id="aclassMR_1_1ViewerSetup_html_a918f69117bd46f408fda277cad5fde2d"><div class="ttname"><a href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a918f69117bd46f408fda277cad5fde2d">MR::ViewerSetup::setupConfiguration</a></div><div class="ttdeci">virtual MRVIEWER_API void setupConfiguration(Viewer *viewer) const</div></div>
183+
<div class="ttc" id="aclassMR_1_1ViewerSetup_html_a9ba29b362190cbfc386b59d8051f8b06"><div class="ttname"><a href="../../MeshLib/Cpp/html/classMR_1_1ViewerSetup.html#a9ba29b362190cbfc386b59d8051f8b06">MR::ViewerSetup::setupSettingsManager</a></div><div class="ttdeci">virtual MRVIEWER_API void setupSettingsManager(Viewer *viewer, const std::string &amp;appName) const</div></div>
184+
<div class="ttc" id="aclassMR_1_1Viewer_html_a26632c3fff60e6f927d932d86503aa8f"><div class="ttname"><a href="../../MeshLib/Cpp/html/classMR_1_1Viewer.html#a26632c3fff60e6f927d932d86503aa8f">MR::Viewer::parseLaunchParams</a></div><div class="ttdeci">static MRVIEWER_API void parseLaunchParams(LaunchParams &amp;params)</div></div>
185+
<div class="ttc" id="aclassMR_1_1Viewer_html_a827107af544bf966370dc8de607ed59c"><div class="ttname"><a href="../../MeshLib/Cpp/html/classMR_1_1Viewer.html#a827107af544bf966370dc8de607ed59c">MR::Viewer::instance</a></div><div class="ttdeci">static Viewer * instance()</div></div>
186+
<div class="ttc" id="anamespaceMR_html_a6804a7415d5f018fa64bf1b533af3d4f"><div class="ttname"><a href="../../MeshLib/Cpp/html/namespaceMR.html#a6804a7415d5f018fa64bf1b533af3d4f">MR::setupLoggerByDefault</a></div><div class="ttdeci">MRMESH_API void setupLoggerByDefault()</div></div>
187+
<div class="ttc" id="anamespaceMR_html_abf0f4c580a56e4a7e297faa1b6de7378"><div class="ttname"><a href="../../MeshLib/Cpp/html/namespaceMR.html#abf0f4c580a56e4a7e297faa1b6de7378">MR::launchDefaultViewer</a></div><div class="ttdeci">MRVIEWER_API int launchDefaultViewer(const Viewer::LaunchParams &amp;params, const ViewerSetup &amp;setup)</div></div>
188+
<div class="ttc" id="astructMR_1_1LaunchParams_html"><div class="ttname"><a href="../../MeshLib/Cpp/html/structMR_1_1LaunchParams.html">MR::LaunchParams</a></div></div>
189+
<div class="ttc" id="astructMR_1_1LaunchParams_html_a25346cad277e065c937a564b8b5f003d"><div class="ttname"><a href="../../MeshLib/Cpp/html/structMR_1_1LaunchParams.html#a25346cad277e065c937a564b8b5f003d">MR::LaunchParams::argc</a></div><div class="ttdeci">int argc</div></div>
174190
</div><!-- fragment --> Then you should make your plugins, to find how have a look at <a class="el" href="StatePluginsHelp.html">State Plugins Overview</a> page</li>
175191
</ul>
176192
</div><div class="tabbed"></div> </div></div><!-- contents -->

0 commit comments

Comments
 (0)