mirror of
				https://github.com/TheLartians/ModernCppStarter.git
				synced 2025-10-31 10:11:34 +01:00 
			
		
		
		
	deploy: 082aa0c7df
				
					
				
			This commit is contained in:
		
							parent
							
								
									74632c4f0e
								
							
						
					
					
						commit
						7980f443fb
					
				
					 103 changed files with 5450 additions and 6875 deletions
				
			
		|  | @ -1,171 +1,179 @@ | |||
| <!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"> | ||||
| <!DOCTYPE html> | ||||
| <html lang="en"> | ||||
| <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::Greeter Class 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" /> | ||||
|   <meta charset="UTF-8" /> | ||||
|   <title>greeter::Greeter class | Greeter</title> | ||||
|   <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" /> | ||||
|   <link rel="stylesheet" href="m-dark+documentation.compiled.css" /> | ||||
|   <link rel="icon" href="favicon-dark.png" type="image/png" /> | ||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||||
|   <meta name="theme-color" content="#22272e" /> | ||||
| </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> | ||||
| <header><nav id="navigation"> | ||||
|   <div class="m-container"> | ||||
|     <div class="m-row"> | ||||
|       <a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">Greeter</a> | ||||
|       <div class="m-col-t-4 m-hide-m m-text-right m-nopadr"> | ||||
|         <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16"> | ||||
|           <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/> | ||||
|         </svg></a> | ||||
|         <a id="m-navbar-show" href="#navigation" title="Show navigation"></a> | ||||
|         <a id="m-navbar-hide" href="#" title="Hide navigation"></a> | ||||
|       </div> | ||||
|       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m"> | ||||
|         <div class="m-row"> | ||||
|           <ol class="m-col-t-6 m-col-m-none"> | ||||
|             <li> | ||||
|               <a href="pages.html">Pages</a> | ||||
|               <ol> | ||||
|                 <li><a href="about.html">About</a></li> | ||||
|               </ol> | ||||
|             </li> | ||||
|             <li><a href="namespaces.html">Namespaces</a></li> | ||||
|           </ol> | ||||
|           <ol class="m-col-t-6 m-col-m-none" start="3"> | ||||
|             <li><a href="annotated.html">Classes</a></li> | ||||
|             <li><a href="files.html">Files</a></li> | ||||
|             <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16"> | ||||
|               <use href="#m-doc-search-icon-path" /> | ||||
|             </svg></a></li> | ||||
|           </ol> | ||||
|         </div> | ||||
|       </div> | ||||
|     </div> | ||||
|   </div> | ||||
|   <div id="splitbar" style="-moz-user-select:none;"  | ||||
|        class="ui-resizable-handle"> | ||||
| </nav></header> | ||||
| <main><article> | ||||
|   <div class="m-container m-container-inflatable"> | ||||
|     <div class="m-row"> | ||||
|       <div class="m-col-l-10 m-push-l-1"> | ||||
|         <h1> | ||||
|           <span class="m-breadcrumb"><a href="namespacegreeter.html">greeter</a>::<wbr/></span>Greeter <span class="m-thin">class</span> | ||||
|           <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="greeter_8h.html"><greeter/greeter.h></a></div> | ||||
|         </h1> | ||||
|         <p>A class for saying hello in multiple languages.</p> | ||||
|         <div class="m-block m-default"> | ||||
|           <h3>Contents</h3> | ||||
|           <ul> | ||||
|             <li> | ||||
|               Reference | ||||
|               <ul> | ||||
|                 <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li> | ||||
|                 <li><a href="#pub-methods">Public functions</a></li> | ||||
|               </ul> | ||||
|             </li> | ||||
|           </ul> | ||||
|         </div> | ||||
|         <section id="typeless-methods"> | ||||
|           <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2> | ||||
|           <dl class="m-doc"> | ||||
|             <dt> | ||||
|               <span class="m-doc-wrap-bumper"><a href="#a0fb6453cab1686d3bac79faa3837be27" class="m-doc">Greeter</a>(</span><span class="m-doc-wrap">std::string name)</span> | ||||
|             </dt> | ||||
|             <dd>Creates a new greeter.</dd> | ||||
|           </dl> | ||||
|         </section> | ||||
|         <section id="pub-methods"> | ||||
|           <h2><a href="#pub-methods">Public functions</a></h2> | ||||
|           <dl class="m-doc"> | ||||
|             <dt> | ||||
|               <span class="m-doc-wrap-bumper">auto <a href="#a462db3413544f40b848095880a3f01c5" class="m-doc">greet</a>(</span><span class="m-doc-wrap"><a href="namespacegreeter.html#aa824aced4428795fef274930c6c22db0" class="m-doc">LanguageCode</a> lang = <a href="namespacegreeter.html#aa824aced4428795fef274930c6c22db0aaa85f1840e282d8a8304dbc2c0d7c9b2" class="m-doc">LanguageCode::<wbr />EN</a>) const -> std::string</span> | ||||
|             </dt> | ||||
|             <dd>Creates a localized string containing the greeting.</dd> | ||||
|           </dl> | ||||
|         </section> | ||||
|         <section> | ||||
|           <h2>Function documentation</h2> | ||||
|           <section class="m-doc-details" id="a0fb6453cab1686d3bac79faa3837be27"><div> | ||||
|             <h3> | ||||
|               <span class="m-doc-wrap-bumper"> greeter::<wbr />Greeter::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0fb6453cab1686d3bac79faa3837be27" class="m-doc-self">Greeter</a>(</span><span class="m-doc-wrap">std::string name)</span></span> | ||||
|             </h3> | ||||
|             <p>Creates a new greeter.</p> | ||||
|             <table class="m-table m-fullwidth m-flat"> | ||||
|               <thead> | ||||
|                 <tr><th colspan="2">Parameters</th></tr> | ||||
|               </thead> | ||||
|               <tbody> | ||||
|                 <tr> | ||||
|                   <td style="width: 1%">name</td> | ||||
|                   <td>the name to greet</td> | ||||
|                 </tr> | ||||
|               </tbody> | ||||
|             </table> | ||||
|           </div></section> | ||||
|           <section class="m-doc-details" id="a462db3413544f40b848095880a3f01c5"><div> | ||||
|             <h3> | ||||
|               <span class="m-doc-wrap-bumper">std::string greeter::<wbr />Greeter::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a462db3413544f40b848095880a3f01c5" class="m-doc-self">greet</a>(</span><span class="m-doc-wrap"><a href="namespacegreeter.html#aa824aced4428795fef274930c6c22db0" class="m-doc">LanguageCode</a> lang = <a href="namespacegreeter.html#aa824aced4428795fef274930c6c22db0aaa85f1840e282d8a8304dbc2c0d7c9b2" class="m-doc">LanguageCode::<wbr />EN</a>) const</span></span> | ||||
|             </h3> | ||||
|             <p>Creates a localized string containing the greeting.</p> | ||||
|             <table class="m-table m-fullwidth m-flat"> | ||||
|               <thead> | ||||
|                 <tr><th colspan="2">Parameters</th></tr> | ||||
|               </thead> | ||||
|               <tbody> | ||||
|                 <tr> | ||||
|                   <td style="width: 1%">lang</td> | ||||
|                   <td>the language to greet in</td> | ||||
|                 </tr> | ||||
|               </tbody> | ||||
|               <tfoot> | ||||
|                 <tr> | ||||
|                   <th>Returns</th> | ||||
|                   <td>a string containing the greeting</td> | ||||
|                 </tr> | ||||
|               </tfoot> | ||||
|             </table> | ||||
|           </div></section> | ||||
|         </section> | ||||
|       </div> | ||||
|     </div> | ||||
|   </div> | ||||
| </article></main> | ||||
| <div class="m-doc-search" id="search"> | ||||
|   <a href="#!" onclick="return hideSearch()"></a> | ||||
|   <div class="m-container"> | ||||
|     <div class="m-row"> | ||||
|       <div class="m-col-m-8 m-push-m-2"> | ||||
|         <div class="m-doc-search-header m-text m-small"> | ||||
|           <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div> | ||||
|           <div id="search-symbolcount">…</div> | ||||
|         </div> | ||||
|         <div class="m-doc-search-content"> | ||||
|           <form> | ||||
|             <input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" /> | ||||
|           </form> | ||||
|           <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript> | ||||
|           <div id="search-help" class="m-text m-dim m-text-center"> | ||||
|             <p class="m-noindent">Search for symbols, directories, files, pages or | ||||
|             modules. You can omit any prefix from the symbol or file path; adding a | ||||
|             <code>:</code> or <code>/</code> suffix lists all members of given symbol or | ||||
|             directory.</p> | ||||
|             <p class="m-noindent">Use <span class="m-label m-dim">↓</span> | ||||
|             / <span class="m-label m-dim">↑</span> to navigate through the list, | ||||
|             <span class="m-label m-dim">Enter</span> to go. | ||||
|             <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can | ||||
|             copy a link to the result using <span class="m-label m-dim">⌘</span> | ||||
|             <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span> | ||||
|             <span class="m-label m-dim">M</span> produces a Markdown link.</p> | ||||
|           </div> | ||||
|           <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div> | ||||
|           <ul id="search-results"></ul> | ||||
|         </div> | ||||
|       </div> | ||||
|     </div> | ||||
|   </div> | ||||
| </div> | ||||
| <script type="text/javascript"> | ||||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||||
| $(document).ready(function(){initNavTree('classgreeter_1_1_greeter.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="summary"> | ||||
| <a href="#pub-methods">Public Member Functions</a> | | ||||
| <a href="classgreeter_1_1_greeter-members.html">List of all members</a>  </div> | ||||
|   <div class="headertitle"> | ||||
| <div class="title">greeter::Greeter Class Reference</div>  </div> | ||||
| </div><!--header--> | ||||
| <div class="contents"> | ||||
| 
 | ||||
| <p><code>#include <<a class="el" href="greeter_8h_source.html">greeter.h</a>></code></p> | ||||
| <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:a032abd03d0ef9beac5dea095fc2809f7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgreeter_1_1_greeter.html#a032abd03d0ef9beac5dea095fc2809f7">Greeter</a> (std::string name)</td></tr> | ||||
| <tr class="separator:a032abd03d0ef9beac5dea095fc2809f7"><td class="memSeparator" colspan="2"> </td></tr> | ||||
| <tr class="memitem:a057e05d8a3779176fadafc679fed2cf2"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgreeter_1_1_greeter.html#a057e05d8a3779176fadafc679fed2cf2">greet</a> (<a class="el" href="namespacegreeter.html#aa824aced4428795fef274930c6c22db0">LanguageCode</a> lang=<a class="el" href="namespacegreeter.html#aa824aced4428795fef274930c6c22db0aaa85f1840e282d8a8304dbc2c0d7c9b2">LanguageCode::EN</a>) const</td></tr> | ||||
| <tr class="separator:a057e05d8a3779176fadafc679fed2cf2"><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 for saying hello in multiple languages </p> | ||||
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> | ||||
| <a id="a032abd03d0ef9beac5dea095fc2809f7"></a> | ||||
| <h2 class="memtitle"><span class="permalink"><a href="#a032abd03d0ef9beac5dea095fc2809f7">◆ </a></span>Greeter()</h2> | ||||
| 
 | ||||
| <div class="memitem"> | ||||
| <div class="memproto"> | ||||
|       <table class="memname"> | ||||
|         <tr> | ||||
|           <td class="memname">Greeter::Greeter </td> | ||||
|           <td>(</td> | ||||
|           <td class="paramtype">std::string </td> | ||||
|           <td class="paramname"><em>name</em></td><td>)</td> | ||||
|           <td></td> | ||||
|         </tr> | ||||
|       </table> | ||||
| </div><div class="memdoc"> | ||||
| <p>Creates a new greeter </p><dl class="params"><dt>Parameters</dt><dd> | ||||
|   <table class="params"> | ||||
|     <tr><td class="paramname">name</td><td>the name to greet </td></tr> | ||||
|   </table> | ||||
|   </dd> | ||||
| </dl> | ||||
| 
 | ||||
| </div> | ||||
| </div> | ||||
| <h2 class="groupheader">Member Function Documentation</h2> | ||||
| <a id="a057e05d8a3779176fadafc679fed2cf2"></a> | ||||
| <h2 class="memtitle"><span class="permalink"><a href="#a057e05d8a3779176fadafc679fed2cf2">◆ </a></span>greet()</h2> | ||||
| 
 | ||||
| <div class="memitem"> | ||||
| <div class="memproto"> | ||||
|       <table class="memname"> | ||||
|         <tr> | ||||
|           <td class="memname">std::string Greeter::greet </td> | ||||
|           <td>(</td> | ||||
|           <td class="paramtype"><a class="el" href="namespacegreeter.html#aa824aced4428795fef274930c6c22db0">LanguageCode</a> </td> | ||||
|           <td class="paramname"><em>lang</em> = <code><a class="el" href="namespacegreeter.html#aa824aced4428795fef274930c6c22db0aaa85f1840e282d8a8304dbc2c0d7c9b2">LanguageCode::EN</a></code></td><td>)</td> | ||||
|           <td> const</td> | ||||
|         </tr> | ||||
|       </table> | ||||
| </div><div class="memdoc"> | ||||
| <p>Creates a localized string containing the greeting </p><dl class="params"><dt>Parameters</dt><dd> | ||||
|   <table class="params"> | ||||
|     <tr><td class="paramname">lang</td><td>the language to greet in </td></tr> | ||||
|   </table> | ||||
|   </dd> | ||||
| </dl> | ||||
| <dl class="section return"><dt>Returns</dt><dd>a string containing the greeting </dd></dl> | ||||
| 
 | ||||
| </div> | ||||
| </div> | ||||
| <hr/>The documentation for this class was generated from the following files:<ul> | ||||
| <li><a class="el" href="greeter_8h_source.html">greeter.h</a></li> | ||||
| <li><a class="el" href="greeter_8cpp.html">greeter.cpp</a></li> | ||||
| </ul> | ||||
| </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="namespacegreeter.html">greeter</a></li><li class="navelem"><a class="el" href="classgreeter_1_1_greeter.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> | ||||
| <script src="search-v1.js"></script> | ||||
| <script src="searchdata-v1.js" async="async"></script> | ||||
| <footer><nav> | ||||
|   <div class="m-container"> | ||||
|     <div class="m-row"> | ||||
|       <div class="m-col-l-10 m-push-l-1"> | ||||
|         <p>Greeter. Created with <a href="https://doxygen.org/">Doxygen</a> 1.8.18 and <a href="https://mcss.mosra.cz/">m.css</a>.</p> | ||||
|       </div> | ||||
|     </div> | ||||
|   </div> | ||||
| </nav></footer> | ||||
| </body> | ||||
| </html> | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue