Skip to content

Commit cac9c07

Browse files
schmoukschmouk
committed
#224-generate doxygen documentation
Completed. Reviewed.
1 parent 2e1ad62 commit cac9c07

File tree

126 files changed

+20199
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+20199
-0
lines changed

‎cpp-strings/cpp-strings.cfg‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Doxyfile 1.14.0
2+
3+
# This file describes the settings to be used by the documentation system
4+
# Doxygen (www.doxygen.org) for a project.
5+
#
6+
# All text after a double hash (##) is considered a comment and is placed in
7+
# front of the TAG it is preceding.
8+
#
9+
# All text after a single hash (#) is considered a comment and will be ignored.
10+
# The format is:
11+
# TAG = value [value, ...]
12+
# For lists, items can also be appended using:
13+
# TAG += value [value, ...]
14+
# Values that contain spaces should be placed between quotes (\" \").
15+
#
16+
# Note:
17+
#
18+
# Use Doxygen to compare the used configuration file with the template
19+
# configuration file:
20+
# doxygen -x [configFile]
21+
# Use Doxygen to compare the used configuration file with the template
22+
# configuration file without replacing the environment variables or CMake type
23+
# replacement variables:
24+
# doxygen -x_noenv [configFile]
25+
26+
#---------------------------------------------------------------------------
27+
# Project related configuration options
28+
#---------------------------------------------------------------------------
29+
PROJECT_NAME = "cpp-strings"
30+
PROJECT_NUMBER = "1.0.0"
31+
PROJECT_BRIEF = "Pythonic c++ strings"
32+
OUTPUT_DIRECTORY =
33+
34+
ABBREVIATE_BRIEF = "The $name class" \
35+
"The $name widget" \
36+
"The $name file" \
37+
is \
38+
provides \
39+
specifies \
40+
contains \
41+
represents \
42+
a \
43+
an \
44+
the
45+
46+
ALWAYS_DETAILED_SEC = YES
47+
FULL_PATH_NAMES = NO
48+
BUILTIN_STL_SUPPORT = YES
49+
TIMESTAMP = DATE ##YES ##NO ##DATETIME ##
50+
51+
#---------------------------------------------------------------------------
52+
# Build related configuration options
53+
#---------------------------------------------------------------------------
54+
HIDE_UNDOC_NAMESPACES = NO
55+
SORT_BRIEF_DOCS = YES
56+
WARN_NO_PARAMDOC = NO
57+
58+
#---------------------------------------------------------------------------
59+
# Configuration options related to the input files
60+
#---------------------------------------------------------------------------
61+
INPUT = ./ ../
62+
INPUT_ENCODING = UTF-8
63+
USE_MDFILE_AS_MAINPAGE = ../README.md
64+
65+
#---------------------------------------------------------------------------
66+
# Configuration options related to source browsing
67+
#---------------------------------------------------------------------------
68+
REFERENCED_BY_RELATION = YES
69+
REFERENCES_RELATION = YES
70+
71+
#---------------------------------------------------------------------------
72+
# Configuration options related to the HTML output
73+
#---------------------------------------------------------------------------
74+
GENERATE_HTML = YES
75+
HTML_OUTPUT = html
76+
HTML_FILE_EXTENSION = .html
77+
HTML_COLORSTYLE_HUE = 220
78+
HTML_COLORSTYLE_SAT = 100
79+
HTML_COLORSTYLE_GAMMA = 80
80+
HTML_DYNAMIC_MENUS = YES
81+
HTML_DYNAMIC_SECTIONS = NO
82+
HTML_CODE_FOLDING = NO ##YES
83+
HTML_COPY_CLIPBOARD = YES
84+
HTML_INDEX_NUM_ENTRIES = 100
85+
GENERATE_TREEVIEW = YES
86+
FULL_SIDEBAR = NO
87+
TREEVIEW_WIDTH = 250
88+
EXT_LINKS_IN_WINDOW = NO
89+
SEARCHENGINE = YES
90+
SERVER_BASED_SEARCH = NO
91+
EXTERNAL_SEARCH = NO
92+
93+
#---------------------------------------------------------------------------
94+
# Configuration options related to the LaTeX output
95+
#---------------------------------------------------------------------------
96+
GENERATE_LATEX = NO

‎cpp-strings/html/annotated.html‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.14.0"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>cpp-strings: Class List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="cookie.js"></script>
17+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
18+
<script type="text/javascript" src="search/searchdata.js"></script>
19+
<script type="text/javascript" src="search/search.js"></script>
20+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
21+
</head>
22+
<body>
23+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
24+
<div id="titlearea">
25+
<table cellspacing="0" cellpadding="0">
26+
<tbody>
27+
<tr id="projectrow">
28+
<td id="projectalign">
29+
<div id="projectname">cpp-strings<span id="projectnumber">&#160;1.0.0</span>
30+
</div>
31+
<div id="projectbrief">Pythonic c++ strings</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.14.0 -->
39+
<script type="text/javascript">
40+
var searchBox = new SearchBox("searchBox", "search/",'.html');
41+
</script>
42+
<script type="text/javascript" src="menudata.js"></script>
43+
<script type="text/javascript" src="menu.js"></script>
44+
<script type="text/javascript">
45+
$(function() {
46+
initMenu('',true,false,'search.php','Search',true);
47+
$(function() { init_search(); });
48+
});
49+
</script>
50+
<div id="main-nav"></div>
51+
</div><!-- top -->
52+
<div id="side-nav" class="ui-resizable side-nav-resizable">
53+
<div id="nav-tree">
54+
<div id="nav-tree-contents">
55+
<div id="nav-sync" class="sync"></div>
56+
</div>
57+
</div>
58+
<div id="splitbar" style="-moz-user-select:none;"
59+
class="ui-resizable-handle">
60+
</div>
61+
</div>
62+
<script type="text/javascript">
63+
$(function(){initNavTree('annotated.html','',''); });
64+
</script>
65+
<div id="container">
66+
<div id="doc-content">
67+
<!-- window showing the filter options -->
68+
<div id="MSearchSelectWindow"
69+
onmouseover="return searchBox.OnSearchSelectShow()"
70+
onmouseout="return searchBox.OnSearchSelectHide()"
71+
onkeydown="return searchBox.OnSearchSelectKey(event)">
72+
</div>
73+
74+
<!-- iframe showing the search results (closed by default) -->
75+
<div id="MSearchResultsWindow">
76+
<div id="MSearchResults">
77+
<div class="SRPage">
78+
<div id="SRIndex">
79+
<div id="SRResults"></div>
80+
<div class="SRStatus" id="Loading">Loading...</div>
81+
<div class="SRStatus" id="Searching">Searching...</div>
82+
<div class="SRStatus" id="NoMatches">No Matches</div>
83+
</div>
84+
</div>
85+
</div>
86+
</div>
87+
88+
<div class="header">
89+
<div class="headertitle"><div class="title">Class List</div></div>
90+
</div><!--header-->
91+
<div class="contents">
92+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
93+
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span><span onclick="javascript:dynsection.toggleLevel(3);">3</span>]</div><table class="directory">
94+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')"><span class="arrowhead opened"></span></span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepcs.html" target="_self">pcs</a></td><td class="desc"></td></tr>
95+
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="dynsection.toggleFolder('0_0_')"><span class="arrowhead opened"></span></span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpcs_1_1_cpp_string_t.html" target="_self">CppStringT</a></td><td class="desc">This is the templated base class for all <a class="el" href="namespacepcs.html#a08d21c458d61442667df24212920d0d9" title="Specialization of basic class with template argument &#39;char&#39;.">CppString</a> classes </td></tr>
96+
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpcs_1_1_cpp_string_t_1_1_not_found_exception.html" target="_self">NotFoundException</a></td><td class="desc"></td></tr>
97+
<tr id="row_0_0_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpcs_1_1_cpp_string_t_1_1_trans_table.html" target="_self">TransTable</a></td><td class="desc">The internal class of translation tables, used with methods CppStringT::maketrans and <a class="el" href="classpcs_1_1_cpp_string_t.html#a2a8c1e78b93da9a0abe471c7a8d85090" title="Returns a copy of the string in which each character has been mapped through the given translation ta...">CppStringT::translate</a> </td></tr>
98+
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpcs_1_1_slice.html" target="_self">Slice</a></td><td class="desc">Base class for slices, with start, stop and step specified values </td></tr>
99+
<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpcs_1_1_start_slice.html" target="_self">StartSlice</a></td><td class="desc">Base class for slices, with start, stop and step specified values </td></tr>
100+
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpcs_1_1_start_step_slice.html" target="_self">StartStepSlice</a></td><td class="desc">Struct of slices with default step values </td></tr>
101+
<tr id="row_0_4_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpcs_1_1_start_stop_slice.html" target="_self">StartStopSlice</a></td><td class="desc">Struct of slices with default start and stop values </td></tr>
102+
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpcs_1_1_step_slice.html" target="_self">StepSlice</a></td><td class="desc">Struct of slices with default start and step values </td></tr>
103+
<tr id="row_0_6_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpcs_1_1_stop_slice.html" target="_self">StopSlice</a></td><td class="desc">Struct of slices with default stop and step values </td></tr>
104+
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpcs_1_1_stop_step_slice.html" target="_self">StopStepSlice</a></td><td class="desc">Struct of slices with default stop values </td></tr>
105+
</table>
106+
</div><!-- directory -->
107+
</div><!-- contents -->
108+
</div><!-- doc-content -->
109+
</div><!-- container -->
110+
<!-- start footer part -->
111+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
112+
<ul>
113+
<li class="footer">Generated on <span class="timestamp"></span> for cpp-strings by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
114+
</ul>
115+
</div>
116+
</body>
117+
</html>

‎cpp-strings/html/annotated_dup.js‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
var annotated_dup =
2+
[
3+
[ "pcs", "namespacepcs.html", [
4+
[ "CppStringT", "classpcs_1_1_cpp_string_t.html", "classpcs_1_1_cpp_string_t" ],
5+
[ "Slice", "classpcs_1_1_slice.html", "classpcs_1_1_slice" ],
6+
[ "StartSlice", "structpcs_1_1_start_slice.html", "structpcs_1_1_start_slice" ],
7+
[ "StartStepSlice", "structpcs_1_1_start_step_slice.html", "structpcs_1_1_start_step_slice" ],
8+
[ "StartStopSlice", "structpcs_1_1_start_stop_slice.html", "structpcs_1_1_start_stop_slice" ],
9+
[ "StepSlice", "structpcs_1_1_step_slice.html", "structpcs_1_1_step_slice" ],
10+
[ "StopSlice", "structpcs_1_1_stop_slice.html", "structpcs_1_1_stop_slice" ],
11+
[ "StopStepSlice", "structpcs_1_1_stop_step_slice.html", "structpcs_1_1_stop_step_slice" ]
12+
] ]
13+
];

‎cpp-strings/html/classes.html‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.14.0"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>cpp-strings: Class Index</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="cookie.js"></script>
17+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
18+
<script type="text/javascript" src="search/searchdata.js"></script>
19+
<script type="text/javascript" src="search/search.js"></script>
20+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
21+
</head>
22+
<body>
23+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
24+
<div id="titlearea">
25+
<table cellspacing="0" cellpadding="0">
26+
<tbody>
27+
<tr id="projectrow">
28+
<td id="projectalign">
29+
<div id="projectname">cpp-strings<span id="projectnumber">&#160;1.0.0</span>
30+
</div>
31+
<div id="projectbrief">Pythonic c++ strings</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.14.0 -->
39+
<script type="text/javascript">
40+
var searchBox = new SearchBox("searchBox", "search/",'.html');
41+
</script>
42+
<script type="text/javascript" src="menudata.js"></script>
43+
<script type="text/javascript" src="menu.js"></script>
44+
<script type="text/javascript">
45+
$(function() {
46+
initMenu('',true,false,'search.php','Search',true);
47+
$(function() { init_search(); });
48+
});
49+
</script>
50+
<div id="main-nav"></div>
51+
</div><!-- top -->
52+
<div id="side-nav" class="ui-resizable side-nav-resizable">
53+
<div id="nav-tree">
54+
<div id="nav-tree-contents">
55+
<div id="nav-sync" class="sync"></div>
56+
</div>
57+
</div>
58+
<div id="splitbar" style="-moz-user-select:none;"
59+
class="ui-resizable-handle">
60+
</div>
61+
</div>
62+
<script type="text/javascript">
63+
$(function(){initNavTree('classes.html','',''); });
64+
</script>
65+
<div id="container">
66+
<div id="doc-content">
67+
<!-- window showing the filter options -->
68+
<div id="MSearchSelectWindow"
69+
onmouseover="return searchBox.OnSearchSelectShow()"
70+
onmouseout="return searchBox.OnSearchSelectHide()"
71+
onkeydown="return searchBox.OnSearchSelectKey(event)">
72+
</div>
73+
74+
<!-- iframe showing the search results (closed by default) -->
75+
<div id="MSearchResultsWindow">
76+
<div id="MSearchResults">
77+
<div class="SRPage">
78+
<div id="SRIndex">
79+
<div id="SRResults"></div>
80+
<div class="SRStatus" id="Loading">Loading...</div>
81+
<div class="SRStatus" id="Searching">Searching...</div>
82+
<div class="SRStatus" id="NoMatches">No Matches</div>
83+
</div>
84+
</div>
85+
</div>
86+
</div>
87+
88+
<div class="header">
89+
<div class="headertitle"><div class="title">Class Index</div></div>
90+
</div><!--header-->
91+
<div class="contents">
92+
<div class="qindex"><a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a></div>
93+
<div class="classindex">
94+
<dl class="classindex even">
95+
<dt class="alphachar"><a id="letter_C" name="letter_C">C</a></dt>
96+
<dd><a class="el" href="classpcs_1_1_cpp_string_t.html">CppStringT</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd></dl>
97+
<dl class="classindex odd">
98+
<dt class="alphachar"><a id="letter_N" name="letter_N">N</a></dt>
99+
<dd><a class="el" href="classpcs_1_1_cpp_string_t_1_1_not_found_exception.html">CppStringT::NotFoundException</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd></dl>
100+
<dl class="classindex even">
101+
<dt class="alphachar"><a id="letter_S" name="letter_S">S</a></dt>
102+
<dd><a class="el" href="classpcs_1_1_slice.html">Slice</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd><dd><a class="el" href="structpcs_1_1_start_slice.html">StartSlice</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd><dd><a class="el" href="structpcs_1_1_start_step_slice.html">StartStepSlice</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd><dd><a class="el" href="structpcs_1_1_start_stop_slice.html">StartStopSlice</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd><dd><a class="el" href="structpcs_1_1_step_slice.html">StepSlice</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd><dd><a class="el" href="structpcs_1_1_stop_slice.html">StopSlice</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd><dd><a class="el" href="structpcs_1_1_stop_step_slice.html">StopStepSlice</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd></dl>
103+
<dl class="classindex odd">
104+
<dt class="alphachar"><a id="letter_T" name="letter_T">T</a></dt>
105+
<dd><a class="el" href="classpcs_1_1_cpp_string_t_1_1_trans_table.html">CppStringT::TransTable</a> (<a class="el" href="namespacepcs.html">pcs</a>)</dd></dl>
106+
</div>
107+
</div><!-- contents -->
108+
</div><!-- doc-content -->
109+
</div><!-- container -->
110+
<!-- start footer part -->
111+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
112+
<ul>
113+
<li class="footer">Generated on <span class="timestamp"></span> for cpp-strings by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
114+
</ul>
115+
</div>
116+
</body>
117+
</html>

0 commit comments

Comments
 (0)