Skip to content

Commit 52bad43

Browse files
committed
Added Docs
1 parent 92b2632 commit 52bad43

File tree

116 files changed

+13036
-5
lines changed

Some content is hidden

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

116 files changed

+13036
-5
lines changed

.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ tests/data/*.json
44
tests/pdal/test_pdalc_*.c
55
!tests/pdal/test_pdalc_utils.c
66

7-
# Ignore doxygen docs
8-
/doc/doxygen
9-
/doc/Doxyfile
10-
117
# Select VS Code configurations
128
.vscode/ipch/**
139
.vscode/settings.json

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ endif()
2323
set(CMAKE_DEBUG_POSTFIX "d" CACHE STRING "CMake debug suffix")
2424
set(CMAKE_RELWITHDEBINFO_POSTFIX "" CACHE STRING "CMake RelWithDebInfo suffix")
2525
set(PDALC_ENABLE_CODE_COVERAGE OFF CACHE BOOL "Enable code coverage calculation")
26-
set(PDALC_ENABLE_DOCS OFF CACHE BOOL "Enable documentation generation")
26+
set(PDALC_ENABLE_DOCS ON CACHE BOOL "Enable documentation generation")
2727
set(PDALC_ENABLE_TESTS ON CACHE BOOL "Enable pdal-c tests")
2828
set(PDALC_GCC_PARAM_GGC_MIN_HEAPSIZE "131072" CACHE STRING "GCC garbage collection minimum heap size")
2929

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
---

Testing/Temporary/LastTest.log

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Start testing: Oct 24 10:58 GMT Summer Time
2+
----------------------------------------------------------
3+
End testing: Oct 24 10:58 GMT Summer Time

doc/Doxyfile

Lines changed: 1649 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
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">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.20"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>pdal-c: C:/Users/runes/Documents/GitHub/capi/README.md File Reference</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+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<td id="projectalign" style="padding-left: 0.5em;">
28+
<div id="projectname">pdal-c
29+
&#160;<span id="projectnumber">v.., with uncommitted changes</span>
30+
</div>
31+
<div id="projectbrief">C API for PDAL</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.8.20 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
42+
/* @license-end */
43+
</script>
44+
<script type="text/javascript" src="menudata.js"></script>
45+
<script type="text/javascript" src="menu.js"></script>
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
48+
$(function() {
49+
initMenu('',true,false,'search.php','Search');
50+
$(document).ready(function() { init_search(); });
51+
});
52+
/* @license-end */</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+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
67+
$(document).ready(function(){initNavTree('_r_e_a_d_m_e_8md.html',''); initResizable(); });
68+
/* @license-end */
69+
</script>
70+
<div id="doc-content">
71+
<!-- window showing the filter options -->
72+
<div id="MSearchSelectWindow"
73+
onmouseover="return searchBox.OnSearchSelectShow()"
74+
onmouseout="return searchBox.OnSearchSelectHide()"
75+
onkeydown="return searchBox.OnSearchSelectKey(event)">
76+
</div>
77+
78+
<!-- iframe showing the search results (closed by default) -->
79+
<div id="MSearchResultsWindow">
80+
<iframe src="javascript:void(0)" frameborder="0"
81+
name="MSearchResults" id="MSearchResults">
82+
</iframe>
83+
</div>
84+
85+
<div class="header">
86+
<div class="headertitle">
87+
<div class="title">C:/Users/runes/Documents/GitHub/capi/README.md File Reference</div> </div>
88+
</div><!--header-->
89+
<div class="contents">
90+
</div><!-- contents -->
91+
</div><!-- doc-content -->
92+
<!-- start footer part -->
93+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
94+
<ul>
95+
<li class="navelem"><a class="el" href="_r_e_a_d_m_e_8md.html">README.md</a></li>
96+
<li class="footer">Generated on Sat Oct 24 2020 10:55:16 for pdal-c by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
97+
</ul>
98+
</div>
99+
</body>
100+
</html>

doc/doxygen/html/annotated.html

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
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">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.20"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>pdal-c: Data Structures</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+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<td id="projectalign" style="padding-left: 0.5em;">
28+
<div id="projectname">pdal-c
29+
&#160;<span id="projectnumber">v.., with uncommitted changes</span>
30+
</div>
31+
<div id="projectbrief">C API for PDAL</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.8.20 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
42+
/* @license-end */
43+
</script>
44+
<script type="text/javascript" src="menudata.js"></script>
45+
<script type="text/javascript" src="menu.js"></script>
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
48+
$(function() {
49+
initMenu('',true,false,'search.php','Search');
50+
$(document).ready(function() { init_search(); });
51+
});
52+
/* @license-end */</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+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
67+
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
68+
/* @license-end */
69+
</script>
70+
<div id="doc-content">
71+
<!-- window showing the filter options -->
72+
<div id="MSearchSelectWindow"
73+
onmouseover="return searchBox.OnSearchSelectShow()"
74+
onmouseout="return searchBox.OnSearchSelectHide()"
75+
onkeydown="return searchBox.OnSearchSelectKey(event)">
76+
</div>
77+
78+
<!-- iframe showing the search results (closed by default) -->
79+
<div id="MSearchResultsWindow">
80+
<iframe src="javascript:void(0)" frameborder="0"
81+
name="MSearchResults" id="MSearchResults">
82+
</iframe>
83+
</div>
84+
85+
<div class="header">
86+
<div class="headertitle">
87+
<div class="title">Data Structures</div> </div>
88+
</div><!--header-->
89+
<div class="contents">
90+
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
91+
<table class="directory">
92+
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_p_d_a_l_dim_type.html" target="_self">PDALDimType</a></td><td class="desc">A dimension type </td></tr>
93+
</table>
94+
</div><!-- directory -->
95+
</div><!-- contents -->
96+
</div><!-- doc-content -->
97+
<!-- start footer part -->
98+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
99+
<ul>
100+
<li class="footer">Generated on Sat Oct 24 2020 10:55:16 for pdal-c by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
101+
</ul>
102+
</div>
103+
</body>
104+
</html>

doc/doxygen/html/annotated_dup.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
var annotated_dup =
2+
[
3+
[ "PDALDimType", "struct_p_d_a_l_dim_type.html", "struct_p_d_a_l_dim_type" ]
4+
];

doc/doxygen/html/bc_s.png

676 Bytes
Loading

doc/doxygen/html/bdwn.png

147 Bytes
Loading

0 commit comments

Comments
 (0)