mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-03-17 20:54:52 +08:00
168 lines
8.0 KiB
HTML
168 lines
8.0 KiB
HTML
<!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" lang="zh">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.5"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Zhamao Framework: 图例</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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">Zhamao Framework<span id="projectnumber"> 3.2.4</span>
|
|
</div>
|
|
<div id="projectbrief">A high-performance chatbot + web framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- 制作者 Doxygen 1.9.5 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','搜索');
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('graph_legend.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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">载入中...</div>
|
|
<div class="SRStatus" id="Searching">搜索中...</div>
|
|
<div class="SRStatus" id="NoMatches">未找到</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">图例</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<p >本页将向您解释如何理解由 doxygen 生成的图.</p>
|
|
<p >考虑如下例子: </p><div class="fragment"><div class="line"><span class="comment">/*! 由于截断而使 Invisible 不可见 */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Invisible { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! Truncated 的继承关系将被隐藏 */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">/* 没有被doxygen文档化的类 */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Undocumented { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! public 继承关系的类 */</span></div>
|
|
<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! 一个模板类 */</span></div>
|
|
<div class="line"><span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! protected 继承关系的类 */</span></div>
|
|
<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! private 继承关系的类 */</span></div>
|
|
<div class="line"><span class="keyword">class </span>PrivateBase { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! 被 Inherited 使用的类 */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Used { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! 继承自其它若干类的超级类 */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
|
|
<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
|
|
<div class="line"> <span class="keyword">private</span> PrivateBase,</div>
|
|
<div class="line"> <span class="keyword">public</span> Undocumented,</div>
|
|
<div class="line"> <span class="keyword">public</span> Templ<int></div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keyword">private</span>:</div>
|
|
<div class="line"> Used *m_usedClass;</div>
|
|
<div class="line">};</div>
|
|
</div><!-- fragment --><p> 结果将会生成以下图:</p>
|
|
<center><iframe scrolling="no" frameborder="0" src="graph_legend.svg" width="682" height="212"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> </center><p >上图中的矩形有如下意义: </p>
|
|
<ul>
|
|
<li>
|
|
灰色填充的矩形 表示上图是由该结构体或类生成. </li>
|
|
<li>
|
|
黑色边框的矩形 表示已经被文档化的结构体或类. </li>
|
|
<li>
|
|
灰色边框的矩形 表示未被文档化的结构体或类. </li>
|
|
<li>
|
|
红色边框的矩形 表示该结构体或类的关系没有被完全显示.如果生成的图不能调整到制定的尺寸，有一些关系就会被截断而不显示出来. </li>
|
|
</ul>
|
|
<p >箭头有如下意义: </p>
|
|
<ul>
|
|
<li>
|
|
深蓝色的箭头被用于展示 public 的继承关系. </li>
|
|
<li>
|
|
深绿色的箭头表示 protected 的继承关系. </li>
|
|
<li>
|
|
深红色的箭头说明了是 privated 的继承关系. </li>
|
|
<li>
|
|
紫色虚线箭头用来表示两个类之间的聚合关系. 被箭头指向的类的类型的变量,可以通过箭头旁标明的变量去访问. </li>
|
|
<li>
|
|
黄色虚线箭头表示模板类实例和模板类之间的关系. 箭头旁边标明了模板类实例化的参数. </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="footer">制作者 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|