mirror of
				https://github.com/TheLartians/ModernCppStarter.git
				synced 2025-10-31 02:01:33 +01:00 
			
		
		
		
	deploy: e48d1c37e5
				
					
				
			This commit is contained in:
		
							parent
							
								
									82e5a65259
								
							
						
					
					
						commit
						74632c4f0e
					
				
					 6 changed files with 116 additions and 10 deletions
				
			
		|  | @ -87,9 +87,9 @@ $(document).ready(function(){initNavTree('dir_d44c64559bbebec7f509842c48db8b23.h | ||||||
| </div><!--header--> | </div><!--header--> | ||||||
| <div class="contents"> | <div class="contents"> | ||||||
| <table class="memberdecls"> | <table class="memberdecls"> | ||||||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a> | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="subdirs"></a> | ||||||
| Files</h2></td></tr> | Directories</h2></td></tr> | ||||||
| <tr class="memitem:greeter_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="greeter_8h.html">greeter.h</a> <a href="greeter_8h_source.html">[code]</a></td></tr> | <tr class="memitem:dir_efc517448da1cf4216d09f3867bece28"><td class="memItemLeft" align="right" valign="top">directory  </td><td class="memItemRight" valign="bottom"><a class="el" href="dir_efc517448da1cf4216d09f3867bece28.html">greeter</a></td></tr> | ||||||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||||||
| </table> | </table> | ||||||
| </div><!-- contents --> | </div><!-- contents --> | ||||||
|  |  | ||||||
							
								
								
									
										107
									
								
								dir_efc517448da1cf4216d09f3867bece28.html
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										107
									
								
								dir_efc517448da1cf4216d09f3867bece28.html
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,107 @@ | ||||||
|  | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/> | ||||||
|  | <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||||||
|  | <title>Greeter: greeter Directory Reference</title> | ||||||
|  | <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||||||
|  | <script type="text/javascript" src="jquery.js"></script> | ||||||
|  | <script type="text/javascript" src="dynsections.js"></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="search/search.css" rel="stylesheet" type="text/css"/> | ||||||
|  | <script type="text/javascript" src="search/searchdata.js"></script> | ||||||
|  | <script type="text/javascript" src="search/search.js"></script> | ||||||
|  | <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||||||
|  | </head> | ||||||
|  | <body> | ||||||
|  | <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">Greeter | ||||||
|  |     <span id="projectnumber">1.0</span> | ||||||
|  |    </div> | ||||||
|  |   </td> | ||||||
|  |  </tr> | ||||||
|  |  </tbody> | ||||||
|  | </table> | ||||||
|  | </div> | ||||||
|  | <!-- end header part --> | ||||||
|  | <!-- Generated by Doxygen 1.8.18 --> | ||||||
|  | <script type="text/javascript"> | ||||||
|  | /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||||||
|  | var searchBox = new SearchBox("searchBox", "search",false,'Search'); | ||||||
|  | /* @license-end */ | ||||||
|  | </script> | ||||||
|  | <script type="text/javascript" src="menudata.js"></script> | ||||||
|  | <script type="text/javascript" src="menu.js"></script> | ||||||
|  | <script type="text/javascript"> | ||||||
|  | /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||||||
|  | $(function() { | ||||||
|  |   initMenu('',true,false,'search.php','Search'); | ||||||
|  |   $(document).ready(function() { init_search(); }); | ||||||
|  | }); | ||||||
|  | /* @license-end */</script> | ||||||
|  | <div id="main-nav"></div> | ||||||
|  | </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('dir_efc517448da1cf4216d09f3867bece28.html',''); initResizable(); }); | ||||||
|  | /* @license-end */ | ||||||
|  | </script> | ||||||
|  | <div id="doc-content"> | ||||||
|  | <!-- window showing the filter options --> | ||||||
|  | <div id="MSearchSelectWindow" | ||||||
|  |      onmouseover="return searchBox.OnSearchSelectShow()" | ||||||
|  |      onmouseout="return searchBox.OnSearchSelectHide()" | ||||||
|  |      onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
|  | <!-- iframe showing the search results (closed by default) --> | ||||||
|  | <div id="MSearchResultsWindow"> | ||||||
|  | <iframe src="javascript:void(0)" frameborder="0"  | ||||||
|  |         name="MSearchResults" id="MSearchResults"> | ||||||
|  | </iframe> | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
|  | <div class="header"> | ||||||
|  |   <div class="headertitle"> | ||||||
|  | <div class="title">greeter Directory Reference</div>  </div> | ||||||
|  | </div><!--header--> | ||||||
|  | <div class="contents"> | ||||||
|  | <table class="memberdecls"> | ||||||
|  | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a> | ||||||
|  | Files</h2></td></tr> | ||||||
|  | <tr class="memitem:greeter_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="greeter_8h.html">greeter.h</a> <a href="greeter_8h_source.html">[code]</a></td></tr> | ||||||
|  | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||||||
|  | </table> | ||||||
|  | </div><!-- contents --> | ||||||
|  | </div><!-- doc-content --> | ||||||
|  | <!-- start footer part --> | ||||||
|  | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||||||
|  |   <ul> | ||||||
|  |     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_efc517448da1cf4216d09f3867bece28.html">greeter</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.18 </li> | ||||||
|  |   </ul> | ||||||
|  | </div> | ||||||
|  | </body> | ||||||
|  | </html> | ||||||
|  | @ -86,7 +86,7 @@ $(document).ready(function(){initNavTree('greeter_8cpp.html',''); initResizable( | ||||||
| <div class="title">greeter.cpp File Reference</div>  </div> | <div class="title">greeter.cpp File Reference</div>  </div> | ||||||
| </div><!--header--> | </div><!--header--> | ||||||
| <div class="contents"> | <div class="contents"> | ||||||
| <div class="textblock"><code>#include <<a class="el" href="greeter_8h_source.html">greeter.h</a>></code><br /> | <div class="textblock"><code>#include <<a class="el" href="greeter_8h_source.html">greeter/greeter.h</a>></code><br /> | ||||||
| </div></div><!-- contents --> | </div></div><!-- contents --> | ||||||
| </div><!-- doc-content --> | </div><!-- doc-content --> | ||||||
| <!-- start footer part --> | <!-- start footer part --> | ||||||
|  |  | ||||||
|  | @ -118,7 +118,7 @@ Enumerations</h2></td></tr> | ||||||
| <!-- start footer part --> | <!-- start footer part --> | ||||||
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||||||
|   <ul> |   <ul> | ||||||
|     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="greeter_8h.html">greeter.h</a></li> |     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_efc517448da1cf4216d09f3867bece28.html">greeter</a></li><li class="navelem"><a class="el" href="greeter_8h.html">greeter.h</a></li> | ||||||
|     <li class="footer">Generated by |     <li class="footer">Generated by | ||||||
|     <a href="http://www.doxygen.org/index.html"> |     <a href="http://www.doxygen.org/index.html"> | ||||||
|     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li> |     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li> | ||||||
|  |  | ||||||
|  | @ -118,7 +118,7 @@ $(document).ready(function(){initNavTree('greeter_8h_source.html',''); initResiz | ||||||
| <!-- start footer part --> | <!-- start footer part --> | ||||||
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||||||
|   <ul> |   <ul> | ||||||
|     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="greeter_8h.html">greeter.h</a></li> |     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_efc517448da1cf4216d09f3867bece28.html">greeter</a></li><li class="navelem"><a class="el" href="greeter_8h.html">greeter.h</a></li> | ||||||
|     <li class="footer">Generated by |     <li class="footer">Generated by | ||||||
|     <a href="http://www.doxygen.org/index.html"> |     <a href="http://www.doxygen.org/index.html"> | ||||||
|     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li> |     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li> | ||||||
|  |  | ||||||
|  | @ -103,8 +103,8 @@ Features</h2> | ||||||
| <li>Code coverage via <a href="https://codecov.io">codecov</a></li> | <li>Code coverage via <a href="https://codecov.io">codecov</a></li> | ||||||
| <li>Code formatting enforced by <a href="https://clang.llvm.org/docs/ClangFormat.html">clang-format</a> via <a href="https://github.com/TheLartians/Format.cmake">Format.cmake</a></li> | <li>Code formatting enforced by <a href="https://clang.llvm.org/docs/ClangFormat.html">clang-format</a> via <a href="https://github.com/TheLartians/Format.cmake">Format.cmake</a></li> | ||||||
| <li>Reproducible dependency management via <a href="https://github.com/TheLartians/CPM.cmake">CPM.cmake</a></li> | <li>Reproducible dependency management via <a href="https://github.com/TheLartians/CPM.cmake">CPM.cmake</a></li> | ||||||
| <li>Installable target with versioning information via <a href="https://github.com/TheLartians/PackageProject.cmake">PackageProject.cmake</a></li> | <li>Installable target with automatic versioning information and header generation via <a href="https://github.com/TheLartians/PackageProject.cmake">PackageProject.cmake</a></li> | ||||||
| <li>Automatic documentation generation with <a href="https://www.doxygen.nl">Doxygen</a></li> | <li>Automatic <a href="https://thelartians.github.io/ModernCppStarter">documentation</a> and deployment with <a href="https://www.doxygen.nl">Doxygen</a> and <a href="https://pages.github.com">GitHub Pages</a></li> | ||||||
| <li>Support for <a href="#additional-tools">sanitizer tools, and more</a></li> | <li>Support for <a href="#additional-tools">sanitizer tools, and more</a></li> | ||||||
| </ul> | </ul> | ||||||
| <h2><a class="anchor" id="autotoc_md2"></a> | <h2><a class="anchor" id="autotoc_md2"></a> | ||||||
|  | @ -148,7 +148,7 @@ Run clang-format</h3> | ||||||
| </div><!-- fragment --><p>See <a href="https://github.com/TheLartians/Format.cmake">Format.cmake</a> for more options.</p> | </div><!-- fragment --><p>See <a href="https://github.com/TheLartians/Format.cmake">Format.cmake</a> for more options.</p> | ||||||
| <h3><a class="anchor" id="autotoc_md7"></a> | <h3><a class="anchor" id="autotoc_md7"></a> | ||||||
| Build the documentation</h3> | Build the documentation</h3> | ||||||
| <p>The documentation is automatically built and updated after every <a href="https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository">release</a>. To manually build documentation, call the following command.</p> | <p>The documentation is automatically built and <a href="https://thelartians.github.io/ModernCppStarter">published</a> whenever a <a href="https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository">GitHub Release</a> is created. To manually build documentation, call the following command.</p> | ||||||
| <div class="fragment"><div class="line">cmake -Hdocumentation -Bbuild/doc</div> | <div class="fragment"><div class="line">cmake -Hdocumentation -Bbuild/doc</div> | ||||||
| <div class="line">cmake --build build/doc --target GenerateDocs</div> | <div class="line">cmake --build build/doc --target GenerateDocs</div> | ||||||
| <div class="line"># view the docs</div> | <div class="line"># view the docs</div> | ||||||
|  | @ -221,4 +221,3 @@ Coming soon</h2> | ||||||
| </div> | </div> | ||||||
| </body> | </body> | ||||||
| </html> | </html> | ||||||
| 
 |  | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue