Skip to content

Commit

Permalink
Add doxygen docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@sorressean
sorressean committed Mar 17, 2021
1 parent 3ac14d2 commit cc77f84
Show file tree
Hide file tree
Showing 676 changed files with 68,661 additions and 0 deletions.
96 changes: 96 additions & 0 deletions docs/html/ChannelManager_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Aspen MUD: src/ChannelManager.h Source File</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="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">Aspen MUD
</div>
<div id="projectbrief">Aspen is a light-weight, barebones mud engine written in c++ utilizing Lua for its&#39; scripting engine.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ChannelManager.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#ifndef ASPEN_CHANNEL_MANAGER_H</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#define ASPEN_CHANNEL_MANAGER_H</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"><a class="line" href="classChannelManager.html"> 7</a></span>&#160;<span class="keyword">class </span><a class="code" href="classChannelManager.html">ChannelManager</a></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;{</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">static</span> <a class="code" href="classChannelManager.html">ChannelManager</a>* _instance;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<a class="code" href="classChannelManager.html">ChannelManager</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;~<a class="code" href="classChannelManager.html">ChannelManager</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">static</span> <a class="code" href="classChannelManager.html">ChannelManager</a>* GetInstance();</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> Initialize();</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> Release();</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;};</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassChannelManager_html"><div class="ttname"><a href="classChannelManager.html">ChannelManager</a></div><div class="ttdef"><b>Definition:</b> ChannelManager.h:8</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 17 2021 11:04:31 for Aspen MUD by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
108 changes: 108 additions & 0 deletions docs/html/ComponentFactory_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Aspen MUD: src/ComponentFactory.h Source File</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="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">Aspen MUD
</div>
<div id="projectbrief">Aspen is a light-weight, barebones mud engine written in c++ utilizing Lua for its&#39; scripting engine.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ComponentFactory.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#ifndef COMPONENT_FACTORY_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#define COMPONENT_FACTORY_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;mud.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;conf.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;component.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;componentMeta.hpp&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classComponentFactory.html"> 18</a></span>&#160;<span class="keyword">class </span><a class="code" href="classComponentFactory.html">ComponentFactory</a></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; std::map &lt;std::string, IComponentMeta*&gt; _components;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="classComponentFactory.html">ComponentFactory</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; ~<a class="code" href="classComponentFactory.html">ComponentFactory</a>();</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classComponentFactory.html#afcfe4f62e132fac1818a244cfb19c6b6">HasComponent</a>(<span class="keyword">const</span> std::string &amp;name);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classComponentFactory.html#a19d03486108e03dfe5abb9eeaa6296e5">RegisterComponent</a>(<span class="keyword">const</span> std::string &amp;name, <a class="code" href="classIComponentMeta.html">IComponentMeta</a>* meta);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="classComponent.html">Component</a>* <a class="code" href="classComponentFactory.html#a90163386646d95a5bb7575bc3683013b">Create</a>(<span class="keyword">const</span> std::string &amp;name);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="classIComponentMeta.html">IComponentMeta</a>* <a class="code" href="classComponentFactory.html#a447e25a1c55a9502a84c8353ec719cc9">GetMeta</a>(<span class="keyword">const</span> std::string &amp;name);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;};</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassComponentFactory_html"><div class="ttname"><a href="classComponentFactory.html">ComponentFactory</a></div><div class="ttdef"><b>Definition:</b> ComponentFactory.h:19</div></div>
<div class="ttc" id="aclassComponentFactory_html_a19d03486108e03dfe5abb9eeaa6296e5"><div class="ttname"><a href="classComponentFactory.html#a19d03486108e03dfe5abb9eeaa6296e5">ComponentFactory::RegisterComponent</a></div><div class="ttdeci">bool RegisterComponent(const std::string &amp;name, IComponentMeta *meta)</div><div class="ttdef"><b>Definition:</b> ComponentFactory.cpp:21</div></div>
<div class="ttc" id="aclassComponentFactory_html_a447e25a1c55a9502a84c8353ec719cc9"><div class="ttname"><a href="classComponentFactory.html#a447e25a1c55a9502a84c8353ec719cc9">ComponentFactory::GetMeta</a></div><div class="ttdeci">IComponentMeta * GetMeta(const std::string &amp;name)</div><div class="ttdef"><b>Definition:</b> ComponentFactory.cpp:43</div></div>
<div class="ttc" id="aclassComponentFactory_html_a90163386646d95a5bb7575bc3683013b"><div class="ttname"><a href="classComponentFactory.html#a90163386646d95a5bb7575bc3683013b">ComponentFactory::Create</a></div><div class="ttdeci">Component * Create(const std::string &amp;name)</div><div class="ttdef"><b>Definition:</b> ComponentFactory.cpp:33</div></div>
<div class="ttc" id="aclassComponentFactory_html_afcfe4f62e132fac1818a244cfb19c6b6"><div class="ttname"><a href="classComponentFactory.html#afcfe4f62e132fac1818a244cfb19c6b6">ComponentFactory::HasComponent</a></div><div class="ttdeci">bool HasComponent(const std::string &amp;name)</div><div class="ttdef"><b>Definition:</b> ComponentFactory.cpp:16</div></div>
<div class="ttc" id="aclassComponent_html"><div class="ttname"><a href="classComponent.html">Component</a></div><div class="ttdef"><b>Definition:</b> component.h:30</div></div>
<div class="ttc" id="aclassIComponentMeta_html"><div class="ttname"><a href="classIComponentMeta.html">IComponentMeta</a></div><div class="ttdef"><b>Definition:</b> componentMeta.hpp:22</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 17 2021 11:04:31 for Aspen MUD by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>

0 comments on commit cc77f84

Please sign in to comment.