Skip to content

Commit 8250cda

Browse files
committed
docs update
1 parent 5b4c72d commit 8250cda

213 files changed

Lines changed: 17191 additions & 1461 deletions

File tree

Some content is hidden

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

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = "PCRE2 C++ Wrapper"
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 1.2.3
51+
PROJECT_NUMBER = 1.2.4
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewers a

docs/html/annotated.html

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
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.15.0"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>PCRE2 C++ Wrapper: 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">PCRE2 C++ Wrapper<span id="projectnumber">&#160;1.2.4</span>
30+
</div>
31+
<div id="projectbrief">pcre2cpp</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.15.0 -->
39+
<script type="text/javascript">
40+
var searchBox = new SearchBox("searchBox", "search/",'.html');
41+
</script>
42+
<script type="text/javascript">
43+
$(function() { codefold.init(); });
44+
</script>
45+
<script type="text/javascript" src="menudata.js"></script>
46+
<script type="text/javascript" src="menu.js"></script>
47+
<script type="text/javascript">
48+
$(function() {
49+
initMenu('',true,false,'search.php','Search',true);
50+
$(function() { init_search(); });
51+
});
52+
</script>
53+
<div id="main-nav"></div>
54+
</div><!-- top -->
55+
<div id="side-nav" class="ui-resizable side-nav-resizable">
56+
<div id="nav-tree">
57+
<div id="nav-tree-contents">
58+
<div id="nav-sync" class="sync"></div>
59+
</div>
60+
</div>
61+
<div id="splitbar" style="-moz-user-select:none;"
62+
class="ui-resizable-handle">
63+
</div>
64+
</div>
65+
<script type="text/javascript">
66+
$(function(){initNavTree('annotated.html','',''); });
67+
</script>
68+
<div id="container">
69+
<div id="doc-content">
70+
<!-- window showing the filter options -->
71+
<div id="MSearchSelectWindow"
72+
onmouseover="return searchBox.OnSearchSelectShow()"
73+
onmouseout="return searchBox.OnSearchSelectHide()"
74+
onkeydown="return searchBox.OnSearchSelectKey(event)">
75+
</div>
76+
77+
<!-- iframe showing the search results (closed by default) -->
78+
<div id="MSearchResultsWindow">
79+
<div id="MSearchResults">
80+
<div class="SRPage">
81+
<div id="SRIndex">
82+
<div id="SRResults"></div>
83+
<div class="SRStatus" id="Loading">Loading...</div>
84+
<div class="SRStatus" id="Searching">Searching...</div>
85+
<div class="SRStatus" id="NoMatches">No Matches</div>
86+
</div>
87+
</div>
88+
</div>
89+
</div>
90+
91+
<div class="header">
92+
<div class="headertitle"><div class="title">Class List</div></div>
93+
</div><!--header-->
94+
<div class="contents">
95+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
96+
<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">
97+
<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="de/d73/namespacepcre2cpp.html" target="_self">pcre2cpp</a></td><td class="desc">Main namespace of <a class="el" href="de/d73/namespacepcre2cpp.html" title="Main namespace of pcre2cpp library.">pcre2cpp</a> library </td></tr>
98+
<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">N</span></span><a class="el" href="d1/d3f/namespacepcre2cpp_1_1utils.html" target="_self">utils</a></td><td class="desc"></td></tr>
99+
<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="d9/d82/structpcre2cpp_1_1utils_1_1pcre2__data.html" target="_self">pcre2_data</a></td><td class="desc">Translation container from pcre2 library to <a class="el" href="de/d73/namespacepcre2cpp.html" title="Main namespace of pcre2cpp library.">pcre2cpp</a> </td></tr>
100+
<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="d6/d82/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__8_01_4.html" target="_self">pcre2_data&lt; utf_type::UTF_8 &gt;</a></td><td class="desc">Specialization of Translation container from pcre2 library to <a class="el" href="de/d73/namespacepcre2cpp.html" title="Main namespace of pcre2cpp library.">pcre2cpp</a> for UTF-8 </td></tr>
101+
<tr id="row_0_0_2_" 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="df/d1d/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__16_01_4.html" target="_self">pcre2_data&lt; utf_type::UTF_16 &gt;</a></td><td class="desc">Specialization of Translation container from pcre2 library to <a class="el" href="de/d73/namespacepcre2cpp.html" title="Main namespace of pcre2cpp library.">pcre2cpp</a> for UTF-16 </td></tr>
102+
<tr id="row_0_0_3_" 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="d1/d85/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__32_01_4.html" target="_self">pcre2_data&lt; utf_type::UTF_32 &gt;</a></td><td class="desc">Specialization of Translation container from pcre2 library to <a class="el" href="de/d73/namespacepcre2cpp.html" title="Main namespace of pcre2cpp library.">pcre2cpp</a> for UTF-32 </td></tr>
103+
<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="df/d63/structpcre2cpp_1_1basic__match__value.html" target="_self">basic_match_value</a></td><td class="desc">Match value container </td></tr>
104+
<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="d1/d9f/classpcre2cpp_1_1basic__match__result.html" target="_self">basic_match_result</a></td><td class="desc">Basic container to result data of match function </td></tr>
105+
<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="de/d88/classpcre2cpp_1_1basic__regex.html" target="_self">basic_regex</a></td><td class="desc">Basic PCRE2 Regex container </td></tr>
106+
<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="d4/df2/structpcre2cpp_1_1sub__match__value.html" target="_self">sub_match_value</a></td><td class="desc">Sub match value container </td></tr>
107+
</table>
108+
</div><!-- directory -->
109+
</div><!-- contents -->
110+
</div><!-- doc-content -->
111+
</div><!-- container -->
112+
<!-- start footer part -->
113+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
114+
<ul>
115+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
116+
</ul>
117+
</div>
118+
</body>
119+
</html>

docs/html/annotated_dup.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
var annotated_dup =
2+
[
3+
[ "pcre2cpp", "de/d73/namespacepcre2cpp.html", [
4+
[ "utils", "d1/d3f/namespacepcre2cpp_1_1utils.html", [
5+
[ "pcre2_data", "d9/d82/structpcre2cpp_1_1utils_1_1pcre2__data.html", null ],
6+
[ "pcre2_data&lt; utf_type::UTF_8 &gt;", "d6/d82/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__8_01_4.html", "d6/d82/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__8_01_4" ],
7+
[ "pcre2_data&lt; utf_type::UTF_16 &gt;", "df/d1d/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__16_01_4.html", "df/d1d/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__16_01_4" ],
8+
[ "pcre2_data&lt; utf_type::UTF_32 &gt;", "d1/d85/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__32_01_4.html", "d1/d85/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__32_01_4" ]
9+
] ],
10+
[ "basic_match_value", "df/d63/structpcre2cpp_1_1basic__match__value.html", "df/d63/structpcre2cpp_1_1basic__match__value" ],
11+
[ "basic_match_result", "d1/d9f/classpcre2cpp_1_1basic__match__result.html", "d1/d9f/classpcre2cpp_1_1basic__match__result" ],
12+
[ "basic_regex", "de/d88/classpcre2cpp_1_1basic__regex.html", "de/d88/classpcre2cpp_1_1basic__regex" ],
13+
[ "sub_match_value", "d4/df2/structpcre2cpp_1_1sub__match__value.html", "d4/df2/structpcre2cpp_1_1sub__match__value" ]
14+
] ]
15+
];

docs/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.15.0"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>PCRE2 C++ Wrapper: 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">PCRE2 C++ Wrapper<span id="projectnumber">&#160;1.2.4</span>
30+
</div>
31+
<div id="projectbrief">pcre2cpp</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.15.0 -->
39+
<script type="text/javascript">
40+
var searchBox = new SearchBox("searchBox", "search/",'.html');
41+
</script>
42+
<script type="text/javascript">
43+
$(function() { codefold.init(); });
44+
</script>
45+
<script type="text/javascript" src="menudata.js"></script>
46+
<script type="text/javascript" src="menu.js"></script>
47+
<script type="text/javascript">
48+
$(function() {
49+
initMenu('',true,false,'search.php','Search',true);
50+
$(function() { init_search(); });
51+
});
52+
</script>
53+
<div id="main-nav"></div>
54+
</div><!-- top -->
55+
<div id="side-nav" class="ui-resizable side-nav-resizable">
56+
<div id="nav-tree">
57+
<div id="nav-tree-contents">
58+
<div id="nav-sync" class="sync"></div>
59+
</div>
60+
</div>
61+
<div id="splitbar" style="-moz-user-select:none;"
62+
class="ui-resizable-handle">
63+
</div>
64+
</div>
65+
<script type="text/javascript">
66+
$(function(){initNavTree('classes.html','',''); });
67+
</script>
68+
<div id="container">
69+
<div id="doc-content">
70+
<!-- window showing the filter options -->
71+
<div id="MSearchSelectWindow"
72+
onmouseover="return searchBox.OnSearchSelectShow()"
73+
onmouseout="return searchBox.OnSearchSelectHide()"
74+
onkeydown="return searchBox.OnSearchSelectKey(event)">
75+
</div>
76+
77+
<!-- iframe showing the search results (closed by default) -->
78+
<div id="MSearchResultsWindow">
79+
<div id="MSearchResults">
80+
<div class="SRPage">
81+
<div id="SRIndex">
82+
<div id="SRResults"></div>
83+
<div class="SRStatus" id="Loading">Loading...</div>
84+
<div class="SRStatus" id="Searching">Searching...</div>
85+
<div class="SRStatus" id="NoMatches">No Matches</div>
86+
</div>
87+
</div>
88+
</div>
89+
</div>
90+
91+
<div class="header">
92+
<div class="headertitle"><div class="title">Class Index</div></div>
93+
</div><!--header-->
94+
<div class="contents">
95+
<div class="qindex"><a class="qindex" href="#letter_B">B</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a></div>
96+
<div class="classindex">
97+
<dl class="classindex even">
98+
<dt class="alphachar"><a id="letter_B" name="letter_B">B</a></dt>
99+
<dd><a class="el" href="d1/d9f/classpcre2cpp_1_1basic__match__result.html">basic_match_result</a> (<a class="el" href="de/d73/namespacepcre2cpp.html">pcre2cpp</a>)</dd><dd><a class="el" href="df/d63/structpcre2cpp_1_1basic__match__value.html">basic_match_value</a> (<a class="el" href="de/d73/namespacepcre2cpp.html">pcre2cpp</a>)</dd><dd><a class="el" href="de/d88/classpcre2cpp_1_1basic__regex.html">basic_regex</a> (<a class="el" href="de/d73/namespacepcre2cpp.html">pcre2cpp</a>)</dd></dl>
100+
<dl class="classindex odd">
101+
<dt class="alphachar"><a id="letter_P" name="letter_P">P</a></dt>
102+
<dd><a class="el" href="d9/d82/structpcre2cpp_1_1utils_1_1pcre2__data.html">pcre2_data</a> (<a class="el" href="d1/d3f/namespacepcre2cpp_1_1utils.html">pcre2cpp::utils</a>)</dd><dd><a class="el" href="df/d1d/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__16_01_4.html">pcre2_data&lt; utf_type::UTF_16 &gt;</a> (<a class="el" href="d1/d3f/namespacepcre2cpp_1_1utils.html">pcre2cpp::utils</a>)</dd><dd><a class="el" href="d1/d85/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__32_01_4.html">pcre2_data&lt; utf_type::UTF_32 &gt;</a> (<a class="el" href="d1/d3f/namespacepcre2cpp_1_1utils.html">pcre2cpp::utils</a>)</dd><dd><a class="el" href="d6/d82/structpcre2cpp_1_1utils_1_1pcre2__data_3_01utf__type_1_1_u_t_f__8_01_4.html">pcre2_data&lt; utf_type::UTF_8 &gt;</a> (<a class="el" href="d1/d3f/namespacepcre2cpp_1_1utils.html">pcre2cpp::utils</a>)</dd></dl>
103+
<dl class="classindex even">
104+
<dt class="alphachar"><a id="letter_S" name="letter_S">S</a></dt>
105+
<dd><a class="el" href="d4/df2/structpcre2cpp_1_1sub__match__value.html">sub_match_value</a> (<a class="el" href="de/d73/namespacepcre2cpp.html">pcre2cpp</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 by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
114+
</ul>
115+
</div>
116+
</body>
117+
</html>
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<map id="pcre2cpp::sub_match_value" name="pcre2cpp::sub_match_value">
2+
<area shape="rect" id="Node000001" title="Sub match value container." alt="" coords="5,125,152,168"/>
3+
<area shape="rect" id="Node000002" title=" " alt="" coords="50,5,107,32"/>
4+
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="81,46,81,126,76,125,76,49"/>
5+
</map>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
cfdcb8e8edd7991e425d45584159dd3b
Lines changed: 68 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)