Skip to content

Commit 77c0d2e

Browse files
scheibelscheibel
committed
Add documentation
1 parent 8e3760e commit 77c0d2e

File tree

3,506 files changed

+210354
-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.

3,506 files changed

+210354
-0
lines changed

‎docs/master/CMakeLists.txt

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
2+
#
3+
# Find doxygen
4+
#
5+
6+
find_package(Doxygen)
7+
if(NOT DOXYGEN_FOUND)
8+
message(STATUS "Disabled generation of doxygen documentation (missing doxygen).")
9+
return()
10+
endif()
11+
12+
13+
#
14+
# Target name
15+
#
16+
17+
set(target api-docs)
18+
message(STATUS "Doc ${target}")
19+
20+
21+
#
22+
# Input file
23+
#
24+
25+
set(doxyfile_in doxyfile.in)
26+
27+
28+
#
29+
# Create documentation
30+
#
31+
32+
# Set project variables
33+
set(doxyfile "${CMAKE_CURRENT_BINARY_DIR}/doxyfile")
34+
set(doxyfile_directory "${CMAKE_CURRENT_BINARY_DIR}/html")
35+
set(doxyfile_html "${doxyfile_directory}/index.html")
36+
37+
# Get filename and path of doxyfile
38+
get_filename_component(name ${doxyfile_in} NAME)
39+
get_filename_component(path ${doxyfile_in} PATH)
40+
if(NOT path)
41+
set(path ${CMAKE_CURRENT_SOURCE_DIR})
42+
endif()
43+
44+
# Configure doxyfile (if it is a real doxyfile already, it should simply copy the file)
45+
set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
46+
configure_file(${doxyfile_in} ${doxyfile})
47+
48+
# Invoke doxygen
49+
add_custom_command(
50+
OUTPUT ${doxyfile_html}
51+
DEPENDS ${doxyfile} ${META_PROJECT_NAME}::cppexpose
52+
WORKING_DIRECTORY ${path}
53+
COMMAND ${CMAKE_COMMAND} -E copy_directory ${path} ${doxyfile_directory} # ToDO, configure doxygen to use source as is
54+
COMMAND ${DOXYGEN} \"${doxyfile}\"
55+
COMMENT "Creating doxygen documentation."
56+
)
57+
58+
# Declare target
59+
add_custom_target(${target} ALL DEPENDS ${doxyfile_html})
60+
add_dependencies(docs ${target})
61+
62+
63+
#
64+
# Deployment
65+
#
66+
67+
install(
68+
DIRECTORY ${doxyfile_directory}
69+
DESTINATION ${INSTALL_DOC}
70+
COMPONENT docs
71+
)

‎docs/master/_abstract_component_8h.html

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
7+
<title>cppexpose: AbstractComponent.h File Reference</title>
8+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9+
<script type="text/javascript" src="jquery.js"></script>
10+
<script type="text/javascript" src="dynsections.js"></script>
11+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
12+
<script type="text/javascript" src="search/searchdata.js"></script>
13+
<script type="text/javascript" src="search/search.js"></script>
14+
<script type="text/javascript">
15+
$(document).ready(function() { init_search(); });
16+
</script>
17+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
18+
</head>
19+
<body>
20+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
21+
<div id="titlearea">
22+
<table cellspacing="0" cellpadding="0">
23+
<tbody>
24+
<tr style="height: 56px;">
25+
<td id="projectlogo"><img alt="Logo" src="cppexpose-logo.png"/></td>
26+
<td id="projectalign" style="padding-left: 0.5em;">
27+
<div id="projectname">cppexpose
28+
&#160;<span id="projectnumber">1.0.0.b785e04f23b8</span>
29+
</div>
30+
<div id="projectbrief">C++ library for type introspection, reflection, and scripting interface</div>
31+
</td>
32+
</tr>
33+
</tbody>
34+
</table>
35+
</div>
36+
<!-- end header part -->
37+
<!-- Generated by Doxygen 1.8.11 -->
38+
<script type="text/javascript">
39+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
40+
</script>
41+
<div id="navrow1" class="tabs">
42+
<ul class="tablist">
43+
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
44+
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
45+
<li><a href="annotated.html"><span>Classes</span></a></li>
46+
<li class="current"><a href="files.html"><span>Files</span></a></li>
47+
<li>
48+
<div id="MSearchBox" class="MSearchBoxInactive">
49+
<span class="left">
50+
<img id="MSearchSelect" src="search/mag_sel.png"
51+
onmouseover="return searchBox.OnSearchSelectShow()"
52+
onmouseout="return searchBox.OnSearchSelectHide()"
53+
alt=""/>
54+
<input type="text" id="MSearchField" value="Search" accesskey="S"
55+
onfocus="searchBox.OnSearchFieldFocus(true)"
56+
onblur="searchBox.OnSearchFieldFocus(false)"
57+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
58+
</span><span class="right">
59+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
60+
</span>
61+
</div>
62+
</li>
63+
</ul>
64+
</div>
65+
<div id="navrow2" class="tabs2">
66+
<ul class="tablist">
67+
<li><a href="files.html"><span>File&#160;List</span></a></li>
68+
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
69+
</ul>
70+
</div>
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 id="nav-path" class="navpath">
86+
<ul>
87+
<li class="navelem"><a class="el" href="dir_dd7c5a5a69118ecc98e53d88dafd9818.html">cppexpose</a></li><li class="navelem"><a class="el" href="dir_a214698cd02278e1a77cee70a292565e.html">include</a></li><li class="navelem"><a class="el" href="dir_07e52b2b81a20ff6028ba98c5f3dafc7.html">cppexpose</a></li><li class="navelem"><a class="el" href="dir_e49b73c080487716d5557a42e0029bc3.html">plugin</a></li> </ul>
88+
</div>
89+
</div><!-- top -->
90+
<div class="header">
91+
<div class="summary">
92+
<a href="#nested-classes">Classes</a> &#124;
93+
<a href="#namespaces">Namespaces</a> </div>
94+
<div class="headertitle">
95+
<div class="title">AbstractComponent.h File Reference</div> </div>
96+
</div><!--header-->
97+
<div class="contents">
98+
<div class="textblock"><code>#include &lt;string&gt;</code><br />
99+
<code>#include &lt;cppexpose/cppexpose_api.h&gt;</code><br />
100+
</div><div class="textblock"><div class="dynheader">
101+
Include dependency graph for AbstractComponent.h:</div>
102+
<div class="dyncontent">
103+
<div class="center"><img src="_abstract_component_8h__incl.png" border="0" usemap="#_abstract_component_8h" alt=""/></div>
104+
<map name="_abstract_component_8h" id="_abstract_component_8h">
105+
</map>
106+
</div>
107+
</div><div class="textblock"><div class="dynheader">
108+
This graph shows which files directly or indirectly include this file:</div>
109+
<div class="dyncontent">
110+
<div class="center"><img src="_abstract_component_8h__dep__incl.png" border="0" usemap="#_abstract_component_8hdep" alt=""/></div>
111+
<map name="_abstract_component_8hdep" id="_abstract_component_8hdep">
112+
<area shape="rect" id="node2" href="_abstract_generic_component_8h.html" title="AbstractGenericComponent.h" alt="" coords="32,80,224,107"/>
113+
<area shape="rect" id="node3" href="_generic_component_8h.html" title="GenericComponent.h" alt="" coords="57,155,199,181"/>
114+
<area shape="rect" id="node4" href="_component_helpers_8h.html" title="ComponentHelpers.h" alt="" coords="57,229,199,256"/>
115+
<area shape="rect" id="node5" href="_component_8h.html" title="Component.h" alt="" coords="5,304,104,331"/>
116+
<area shape="rect" id="node7" href="_component_manager_8h.html" title="ComponentManager.h" alt="" coords="129,304,277,331"/>
117+
<area shape="rect" id="node6" href="plugin__api_8h.html" title="plugin_api.h" alt="" coords="83,379,173,405"/>
118+
</map>
119+
</div>
120+
</div>
121+
<p><a href="_abstract_component_8h_source.html">Go to the source code of this file.</a></p>
122+
<table class="memberdecls">
123+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
124+
Classes</h2></td></tr>
125+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcppexpose_1_1_abstract_component.html">cppexpose::AbstractComponent</a></td></tr>
126+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for components. <a href="classcppexpose_1_1_abstract_component.html#details">More...</a><br /></td></tr>
127+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
128+
</table><table class="memberdecls">
129+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
130+
Namespaces</h2></td></tr>
131+
<tr class="memitem:namespacecppexpose"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecppexpose.html">cppexpose</a></td></tr>
132+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
133+
</table>
134+
</div><!-- contents -->
135+
<!-- start footer part -->
136+
<hr class="footer"/><address class="footer"><small>
137+
Generated on Sat Oct 20 2018 00:21:36 for cppexpose by &#160;<a href="http://www.doxygen.org/index.html">
138+
<img class="footer" src="doxygen.png" alt="doxygen"/>
139+
</a> 1.8.11
140+
</small></address>
141+
</body>
142+
</html>

‎docs/master/_abstract_component_8h__dep__incl.map

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<map id="AbstractComponent.h" name="AbstractComponent.h">
2+
<area shape="rect" id="node2" href="$_abstract_generic_component_8h.html" title="AbstractGenericComponent.h" alt="" coords="32,80,224,107"/>
3+
<area shape="rect" id="node3" href="$_generic_component_8h.html" title="GenericComponent.h" alt="" coords="57,155,199,181"/>
4+
<area shape="rect" id="node4" href="$_component_helpers_8h.html" title="ComponentHelpers.h" alt="" coords="57,229,199,256"/>
5+
<area shape="rect" id="node5" href="$_component_8h.html" title="Component.h" alt="" coords="5,304,104,331"/>
6+
<area shape="rect" id="node7" href="$_component_manager_8h.html" title="ComponentManager.h" alt="" coords="129,304,277,331"/>
7+
<area shape="rect" id="node6" href="$plugin__api_8h.html" title="plugin_api.h" alt="" coords="83,379,173,405"/>
8+
</map>

‎docs/master/_abstract_component_8h__dep__incl.md5

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
af579516ad7575a387de4b363de2721b

‎docs/master/_abstract_component_8h__dep__incl.png

18.7 KB
Loading

‎docs/master/_abstract_component_8h__incl.map

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<map id="AbstractComponent.h" name="AbstractComponent.h">
2+
</map>

‎docs/master/_abstract_component_8h__incl.md5

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
09189031a482359cf0ab4cfaba290031

‎docs/master/_abstract_component_8h__incl.png

7.56 KB
Loading

0 commit comments

Comments
 (0)