diff options
| author | Allen Winter <allen.winter@kdab.com> | 2017-07-20 08:16:04 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-07-20 08:16:04 -0400 |
| commit | 8ff42df7a225b1115ba8b54389d41f7429478ba3 (patch) | |
| tree | e5cd99b7eb745bd03745b46d8b93d4fe56c0d32a /apidocs/graph_legend.html | |
| parent | 8432310a4aaf2ee139b63a2fa201a0441c138ac8 (diff) | |
| parent | 153fa696c18b95e508022e0cc6ce2326676135e5 (diff) | |
| download | libical-git-8ff42df7a225b1115ba8b54389d41f7429478ba3.tar.gz | |
Merge pull request #311 from xfbs/gh-pages
Updates apidocs
Diffstat (limited to 'apidocs/graph_legend.html')
| -rw-r--r-- | apidocs/graph_legend.html | 95 |
1 files changed, 22 insertions, 73 deletions
diff --git a/apidocs/graph_legend.html b/apidocs/graph_legend.html index 99ee0f22..960a99fa 100644 --- a/apidocs/graph_legend.html +++ b/apidocs/graph_legend.html @@ -3,17 +3,15 @@ <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.9.1"/> -<title>Libical: Graph Legend</title> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Libical API Documentation: Graph Legend</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> -<script type="text/javascript"> - $(document).ready(function() { init_search(); }); -</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -22,9 +20,9 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Libical -  <span id="projectnumber">2.0</span> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Libical API Documentation +  <span id="projectnumber">2.99</span> </div> </td> </tr> @@ -32,34 +30,19 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.9.1 --> +<!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="pages.html"><span>Related Pages</span></a></li> - <li><a href="annotated.html"><span>Data Structures</span></a></li> - <li><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -81,43 +64,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div><!--header--> <div class="contents"> <p>This page explains how to interpret the graphs that are generated by doxygen.</p> -<p>Consider the following example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> /*! Invisible class because of truncation */</div> -<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> class Invisible { };</div> -<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div> -<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> /*! Truncated class, inheritance relation is hidden */</div> -<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> class Truncated : public Invisible { };</div> -<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div> -<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> /* Class not documented with doxygen comments */</div> -<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> class Undocumented { };</div> -<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> -<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> /*! Class that is inherited using public inheritance */</div> -<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> class PublicBase : public Truncated { };</div> -<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> -<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> /*! A template class */</div> -<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> template<class T> class Templ { };</div> -<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> -<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> /*! Class that is inherited using protected inheritance */</div> -<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> class ProtectedBase { };</div> -<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> -<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> /*! Class that is inherited using private inheritance */</div> -<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> class PrivateBase { };</div> -<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> -<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> /*! Class that is used by the Inherited class */</div> -<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> class Used { };</div> -<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> -<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> /*! Super class that inherits a number of other classes */</div> -<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> class Inherited : public PublicBase,</div> -<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  protected ProtectedBase,</div> -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  private PrivateBase,</div> -<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  public Undocumented,</div> -<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  public Templ<int></div> -<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div> -<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  private:</div> -<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  Used *m_usedClass;</div> -<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> };</div> -</div><!-- fragment --><p> This will result in the following graph:</p> +<p>Consider the following example: </p><div class="fragment"><div class="line">/*! Invisible class because of truncation */</div><div class="line">class Invisible { };</div><div class="line"></div><div class="line">/*! Truncated class, inheritance relation is hidden */</div><div class="line">class Truncated : public Invisible { };</div><div class="line"></div><div class="line">/* Class not documented with doxygen comments */</div><div class="line">class Undocumented { };</div><div class="line"></div><div class="line">/*! Class that is inherited using public inheritance */</div><div class="line">class PublicBase : public Truncated { };</div><div class="line"></div><div class="line">/*! A template class */</div><div class="line">template<class T> class Templ { };</div><div class="line"></div><div class="line">/*! Class that is inherited using protected inheritance */</div><div class="line">class ProtectedBase { };</div><div class="line"></div><div class="line">/*! Class that is inherited using private inheritance */</div><div class="line">class PrivateBase { };</div><div class="line"></div><div class="line">/*! Class that is used by the Inherited class */</div><div class="line">class Used { };</div><div class="line"></div><div class="line">/*! Super class that inherits a number of other classes */</div><div class="line">class Inherited : public PublicBase,</div><div class="line"> protected ProtectedBase,</div><div class="line"> private PrivateBase,</div><div class="line"> public Undocumented,</div><div class="line"> public Templ<int></div><div class="line">{</div><div class="line"> private:</div><div class="line"> Used *m_usedClass;</div><div class="line">};</div></div><!-- fragment --><p> This will result in the following graph:</p> <center><div class="image"> -<img src="graph_legend.png" /> +<img src="graph_legend.png"/> </div> </center><p>The boxes in the above graph have the following meaning: </p> <ul> @@ -126,7 +75,7 @@ A filled gray box represents the struct or class for which the graph is generate <li> A box with a black border denotes a documented struct or class. </li> <li> -A box with a grey border denotes an undocumented struct or class. </li> +A box with a gray border denotes an undocumented struct or class. </li> <li> A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries. </li> </ul> @@ -139,16 +88,16 @@ A dark green arrow is used for protected inheritance. </li> <li> A dark red arrow is used for private inheritance. </li> <li> -A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible. </li> +A purple dashed arrow is used if a class is contained or used by another class. The arrow is labelled with the variable(s) through which the pointed class or struct is accessible. </li> <li> -A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance. </li> +A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance. </li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.9.1 +</a> 1.8.13 </small></address> </body> </html> |