Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitcac9c07

Browse files
committed
#224-generate doxygen documentation
Completed. Reviewed.
1 parent2e1ad62 commitcac9c07

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+
<htmlxmlns="http://www.w3.org/1999/xhtml"lang="en-US">
3+
<head>
4+
<metahttp-equiv="Content-Type"content="text/xhtml;charset=UTF-8"/>
5+
<metahttp-equiv="X-UA-Compatible"content="IE=11"/>
6+
<metaname="generator"content="Doxygen 1.14.0"/>
7+
<metaname="viewport"content="width=device-width, initial-scale=1"/>
8+
<title>cpp-strings: Class List</title>
9+
<linkhref="tabs.css"rel="stylesheet"type="text/css"/>
10+
<scripttype="text/javascript"src="jquery.js"></script>
11+
<scripttype="text/javascript"src="dynsections.js"></script>
12+
<scripttype="text/javascript"src="clipboard.js"></script>
13+
<linkhref="navtree.css"rel="stylesheet"type="text/css"/>
14+
<scripttype="text/javascript"src="navtreedata.js"></script>
15+
<scripttype="text/javascript"src="navtree.js"></script>
16+
<scripttype="text/javascript"src="cookie.js"></script>
17+
<linkhref="search/search.css"rel="stylesheet"type="text/css"/>
18+
<scripttype="text/javascript"src="search/searchdata.js"></script>
19+
<scripttype="text/javascript"src="search/search.js"></script>
20+
<linkhref="doxygen.css"rel="stylesheet"type="text/css"/>
21+
</head>
22+
<body>
23+
<divid="top"><!-- do not remove this div, it is closed by doxygen! -->
24+
<divid="titlearea">
25+
<tablecellspacing="0"cellpadding="0">
26+
<tbody>
27+
<trid="projectrow">
28+
<tdid="projectalign">
29+
<divid="projectname">cpp-strings<spanid="projectnumber">&#160;1.0.0</span>
30+
</div>
31+
<divid="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+
<scripttype="text/javascript">
40+
varsearchBox=newSearchBox("searchBox","search/",'.html');
41+
</script>
42+
<scripttype="text/javascript"src="menudata.js"></script>
43+
<scripttype="text/javascript"src="menu.js"></script>
44+
<scripttype="text/javascript">
45+
$(function(){
46+
initMenu('',true,false,'search.php','Search',true);
47+
$(function(){init_search();});
48+
});
49+
</script>
50+
<divid="main-nav"></div>
51+
</div><!-- top -->
52+
<divid="side-nav"class="ui-resizable side-nav-resizable">
53+
<divid="nav-tree">
54+
<divid="nav-tree-contents">
55+
<divid="nav-sync"class="sync"></div>
56+
</div>
57+
</div>
58+
<divid="splitbar"style="-moz-user-select:none;"
59+
class="ui-resizable-handle">
60+
</div>
61+
</div>
62+
<scripttype="text/javascript">
63+
$(function(){initNavTree('annotated.html','','');});
64+
</script>
65+
<divid="container">
66+
<divid="doc-content">
67+
<!-- window showing the filter options -->
68+
<divid="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+
<divid="MSearchResultsWindow">
76+
<divid="MSearchResults">
77+
<divclass="SRPage">
78+
<divid="SRIndex">
79+
<divid="SRResults"></div>
80+
<divclass="SRStatus"id="Loading">Loading...</div>
81+
<divclass="SRStatus"id="Searching">Searching...</div>
82+
<divclass="SRStatus"id="NoMatches">No Matches</div>
83+
</div>
84+
</div>
85+
</div>
86+
</div>
87+
88+
<divclass="header">
89+
<divclass="headertitle"><divclass="title">Class List</div></div>
90+
</div><!--header-->
91+
<divclass="contents">
92+
<divclass="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><divclass="directory">
93+
<divclass="levels">[detail level<spanonclick="#"diff-b4f23028acc3a3215e5ba760559f85a9dafe6d91c362a81dc0d87d628778c4ea-empty-94-0" data-selected="false" role="gridcell" tabindex="-1" valign="top">
94+
<trid="row_0_"class="even"><tdclass="entry"><spanstyle="width:0px;display:inline-block;">&#160;</span><spanid="arr_0_"class="arrow"onclick="dynsection.toggleFolder('0_')"><spanclass="arrowhead opened"></span></span><spanclass="icona"><spanclass="icon">N</span></span><aclass="el"href="namespacepcs.html"target="_self">pcs</a></td><tdclass="desc"></td></tr>
95+
<trid="row_0_0_"class="odd"><tdclass="entry"><spanstyle="width:16px;display:inline-block;">&#160;</span><spanid="arr_0_0_"class="arrow"onclick="dynsection.toggleFolder('0_0_')"><spanclass="arrowhead opened"></span></span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classpcs_1_1_cpp_string_t.html"target="_self">CppStringT</a></td><tdclass="desc">This is the templated base class for all<aclass="el"href="namespacepcs.html#a08d21c458d61442667df24212920d0d9"title="Specialization of basic class with template argument &#39;char&#39;.">CppString</a> classes</td></tr>
96+
<trid="row_0_0_0_"class="even"><tdclass="entry"><spanstyle="width:48px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classpcs_1_1_cpp_string_t_1_1_not_found_exception.html"target="_self">NotFoundException</a></td><tdclass="desc"></td></tr>
97+
<trid="row_0_0_1_"class="odd"><tdclass="entry"><spanstyle="width:48px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classpcs_1_1_cpp_string_t_1_1_trans_table.html"target="_self">TransTable</a></td><tdclass="desc">The internal class of translation tables, used with methods CppStringT::maketrans and<aclass="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+
<trid="row_0_1_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classpcs_1_1_slice.html"target="_self">Slice</a></td><tdclass="desc">Base class for slices, with start, stop and step specified values</td></tr>
99+
<trid="row_0_2_"class="odd"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structpcs_1_1_start_slice.html"target="_self">StartSlice</a></td><tdclass="desc">Base class for slices, with start, stop and step specified values</td></tr>
100+
<trid="row_0_3_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structpcs_1_1_start_step_slice.html"target="_self">StartStepSlice</a></td><tdclass="desc">Struct of slices with default step values</td></tr>
101+
<trid="row_0_4_"class="odd"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structpcs_1_1_start_stop_slice.html"target="_self">StartStopSlice</a></td><tdclass="desc">Struct of slices with default start and stop values</td></tr>
102+
<trid="row_0_5_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structpcs_1_1_step_slice.html"target="_self">StepSlice</a></td><tdclass="desc">Struct of slices with default start and step values</td></tr>
103+
<trid="row_0_6_"class="odd"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structpcs_1_1_stop_slice.html"target="_self">StopSlice</a></td><tdclass="desc">Struct of slices with default stop and step values</td></tr>
104+
<trid="row_0_7_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structpcs_1_1_stop_step_slice.html"target="_self">StopStepSlice</a></td><tdclass="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+
<divid="nav-path"class="navpath"><!-- id is needed for treeview function! -->
112+
<ul>
113+
<liclass="footer">Generated on<spanclass="timestamp"></span> for cpp-strings by<ahref="https://www.doxygen.org/index.html"><imgclass="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+
varannotated_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+
<htmlxmlns="http://www.w3.org/1999/xhtml"lang="en-US">
3+
<head>
4+
<metahttp-equiv="Content-Type"content="text/xhtml;charset=UTF-8"/>
5+
<metahttp-equiv="X-UA-Compatible"content="IE=11"/>
6+
<metaname="generator"content="Doxygen 1.14.0"/>
7+
<metaname="viewport"content="width=device-width, initial-scale=1"/>
8+
<title>cpp-strings: Class Index</title>
9+
<linkhref="tabs.css"rel="stylesheet"type="text/css"/>
10+
<scripttype="text/javascript"src="jquery.js"></script>
11+
<scripttype="text/javascript"src="dynsections.js"></script>
12+
<scripttype="text/javascript"src="clipboard.js"></script>
13+
<linkhref="navtree.css"rel="stylesheet"type="text/css"/>
14+
<scripttype="text/javascript"src="navtreedata.js"></script>
15+
<scripttype="text/javascript"src="navtree.js"></script>
16+
<scripttype="text/javascript"src="cookie.js"></script>
17+
<linkhref="search/search.css"rel="stylesheet"type="text/css"/>
18+
<scripttype="text/javascript"src="search/searchdata.js"></script>
19+
<scripttype="text/javascript"src="search/search.js"></script>
20+
<linkhref="doxygen.css"rel="stylesheet"type="text/css"/>
21+
</head>
22+
<body>
23+
<divid="top"><!-- do not remove this div, it is closed by doxygen! -->
24+
<divid="titlearea">
25+
<tablecellspacing="0"cellpadding="0">
26+
<tbody>
27+
<trid="projectrow">
28+
<tdid="projectalign">
29+
<divid="projectname">cpp-strings<spanid="projectnumber">&#160;1.0.0</span>
30+
</div>
31+
<divid="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+
<scripttype="text/javascript">
40+
varsearchBox=newSearchBox("searchBox","search/",'.html');
41+
</script>
42+
<scripttype="text/javascript"src="menudata.js"></script>
43+
<scripttype="text/javascript"src="menu.js"></script>
44+
<scripttype="text/javascript">
45+
$(function(){
46+
initMenu('',true,false,'search.php','Search',true);
47+
$(function(){init_search();});
48+
});
49+
</script>
50+
<divid="main-nav"></div>
51+
</div><!-- top -->
52+
<divid="side-nav"class="ui-resizable side-nav-resizable">
53+
<divid="nav-tree">
54+
<divid="nav-tree-contents">
55+
<divid="nav-sync"class="sync"></div>
56+
</div>
57+
</div>
58+
<divid="splitbar"style="-moz-user-select:none;"
59+
class="ui-resizable-handle">
60+
</div>
61+
</div>
62+
<scripttype="text/javascript">
63+
$(function(){initNavTree('classes.html','','');});
64+
</script>
65+
<divid="container">
66+
<divid="doc-content">
67+
<!-- window showing the filter options -->
68+
<divid="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+
<divid="MSearchResultsWindow">
76+
<divid="MSearchResults">
77+
<divclass="SRPage">
78+
<divid="SRIndex">
79+
<divid="SRResults"></div>
80+
<divclass="SRStatus"id="Loading">Loading...</div>
81+
<divclass="SRStatus"id="Searching">Searching...</div>
82+
<divclass="SRStatus"id="NoMatches">No Matches</div>
83+
</div>
84+
</div>
85+
</div>
86+
</div>
87+
88+
<divclass="header">
89+
<divclass="headertitle"><divclass="title">Class Index</div></div>
90+
</div><!--header-->
91+
<divclass="contents">
92+
<divclass="qindex"><aclass="qindex"href="#letter_C">C</a>&#160;|&#160;<aclass="qindex"href="#letter_N">N</a>&#160;|&#160;<aclass="qindex"href="#letter_S">S</a>&#160;|&#160;<aclass="qindex"href="#letter_T">T</a></div>
93+
<divclass="classindex">
94+
<dlclass="classindex even">
95+
<dtclass="alphachar"><aid="letter_C"name="letter_C">C</a></dt>
96+
<dd><aclass="el"href="classpcs_1_1_cpp_string_t.html">CppStringT</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd></dl>
97+
<dlclass="classindex odd">
98+
<dtclass="alphachar"><aid="letter_N"name="letter_N">N</a></dt>
99+
<dd><aclass="el"href="classpcs_1_1_cpp_string_t_1_1_not_found_exception.html">CppStringT::NotFoundException</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd></dl>
100+
<dlclass="classindex even">
101+
<dtclass="alphachar"><aid="letter_S"name="letter_S">S</a></dt>
102+
<dd><aclass="el"href="classpcs_1_1_slice.html">Slice</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd><dd><aclass="el"href="structpcs_1_1_start_slice.html">StartSlice</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd><dd><aclass="el"href="structpcs_1_1_start_step_slice.html">StartStepSlice</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd><dd><aclass="el"href="structpcs_1_1_start_stop_slice.html">StartStopSlice</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd><dd><aclass="el"href="structpcs_1_1_step_slice.html">StepSlice</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd><dd><aclass="el"href="structpcs_1_1_stop_slice.html">StopSlice</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd><dd><aclass="el"href="structpcs_1_1_stop_step_slice.html">StopStepSlice</a> (<aclass="el"href="namespacepcs.html">pcs</a>)</dd></dl>
103+
<dlclass="classindex odd">
104+
<dtclass="alphachar"><aid="letter_T"name="letter_T">T</a></dt>
105+
<dd><aclass="el"href="classpcs_1_1_cpp_string_t_1_1_trans_table.html">CppStringT::TransTable</a> (<aclass="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+
<divid="nav-path"class="navpath"><!-- id is needed for treeview function! -->
112+
<ul>
113+
<liclass="footer">Generated on<spanclass="timestamp"></span> for cpp-strings by<ahref="https://www.doxygen.org/index.html"><imgclass="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)
[8]ページ先頭
©2009-2025 Movatter.jp