Skip to content

Commit 714d630

Browse files
fallbergfallberg
committed
Merge pull request arduino#283 from mysensors/documentation
Documentation
2 parents 3a36bcf + 68e8c24 commit 714d630

Some content is hidden

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

41 files changed

+16736
-367
lines changed

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ stino.settings
22
*~
33
*bak
44
MyPrivateConfig.h
5+
Documentation/html
6+
doxygen_sqlite3.db

‎Documentation/Doxyfile

Lines changed: 2291 additions & 0 deletions
Large diffs are not rendered by default.

‎Documentation/img/MySigning/alicenbob.eps

Lines changed: 1715 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Documentation/img/MySigning/alicenbob.png

13.2 KB
Loading

‎Documentation/img/MySigning/alicenfriends.eps

Lines changed: 638 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Documentation/img/MySigning/alicenfriends.png

8.09 KB
Loading

‎Documentation/img/MySigning/alicenfriends2.eps

Lines changed: 628 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Documentation/img/MySigning/alicenfriends2.png

7.39 KB
Loading

‎Documentation/img/MySigning/signingillustrated1.eps

Lines changed: 968 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Documentation/img/MySigning/signingillustrated1.png

5.99 KB
Loading

‎Documentation/img/MySigning/signingillustrated2.eps

Lines changed: 4549 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Documentation/img/MySigning/signingillustrated2.gif

34.4 KB
Loading

‎Documentation/img/MySigning/signingillustrated2.png

26.9 KB
Loading

‎Documentation/img/MySigning/signingsequence.eps

Lines changed: 2204 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Documentation/img/MySigning/signingsequence.png

20 KB
Loading

‎Documentation/img/logo.png

5.58 KB
Loading

‎Documentation/mainpage.dox

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/**
2+
@mainpage MySensors library and examples documentation
3+
4+
@copyright (C) 2013-2015 Sensnology AB
5+
6+
Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
7+
*/
8+
/**
9+
@defgroup internals MySensors internal APIs and functionalities
10+
*/

‎Documentation/styles/footerFile.html

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- HTML footer for doxygen 1.8.6-->
2+
<!-- start footer part -->
3+
<!--BEGIN GENERATE_TREEVIEW-->
4+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
5+
<ul>
6+
$navpath
7+
<li class="footer">$generatedby
8+
<a href="http://www.doxygen.org/index.html">
9+
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
10+
</ul>
11+
</div>
12+
<!--END GENERATE_TREEVIEW-->
13+
<!--BEGIN !GENERATE_TREEVIEW-->
14+
<hr class="footer"/><address class="footer"><small>
15+
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
16+
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
17+
</a> $doxygenversion
18+
</small></address>
19+
<!--END !GENERATE_TREEVIEW-->
20+
</body>
21+
</html>

‎Documentation/styles/headerFile.html

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!-- HTML header for doxygen 1.8.6-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7+
<meta name="generator" content="Doxygen $doxygenversion"/>
8+
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
9+
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
10+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
11+
<script type="text/javascript" src="$relpath^jquery.js"></script>
12+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
13+
$treeview
14+
$search
15+
$mathjax
16+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
17+
$extrastylesheet
18+
</head>
19+
<body>
20+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
21+
22+
<!--BEGIN TITLEAREA-->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<!--BEGIN PROJECT_LOGO-->
28+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
29+
<!--END PROJECT_LOGO-->
30+
<!--BEGIN PROJECT_NAME-->
31+
<td style="padding-left: 0.5em;">
32+
<div id="projectname">$projectname
33+
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
34+
</div>
35+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
36+
</td>
37+
<!--END PROJECT_NAME-->
38+
<!--BEGIN !PROJECT_NAME-->
39+
<!--BEGIN PROJECT_BRIEF-->
40+
<td style="padding-left: 0.5em;">
41+
<div id="projectbrief">$projectbrief</div>
42+
</td>
43+
<!--END PROJECT_BRIEF-->
44+
<!--END !PROJECT_NAME-->
45+
<!--BEGIN DISABLE_INDEX-->
46+
<!--BEGIN SEARCHENGINE-->
47+
<td>$searchbox</td>
48+
<!--END SEARCHENGINE-->
49+
<!--END DISABLE_INDEX-->
50+
</tr>
51+
</tbody>
52+
</table>
53+
</div>
54+
<!--END TITLEAREA-->
55+
<!-- end header part -->

‎Documentation/styles/html/footerFile.html

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- HTML footer for doxygen 1.8.6-->
2+
<!-- start footer part -->
3+
<!--BEGIN GENERATE_TREEVIEW-->
4+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
5+
<ul>
6+
$navpath
7+
<li class="footer">$generatedby
8+
<a href="http://www.doxygen.org/index.html">
9+
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
10+
</ul>
11+
</div>
12+
<!--END GENERATE_TREEVIEW-->
13+
<!--BEGIN !GENERATE_TREEVIEW-->
14+
<hr class="footer"/><address class="footer"><small>
15+
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
16+
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
17+
</a> $doxygenversion
18+
</small></address>
19+
<!--END !GENERATE_TREEVIEW-->
20+
</body>
21+
</html>

‎Documentation/styles/html/headerFile.html

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!-- HTML header for doxygen 1.8.6-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7+
<meta name="generator" content="Doxygen $doxygenversion"/>
8+
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
9+
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
10+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
11+
<script type="text/javascript" src="$relpath^jquery.js"></script>
12+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
13+
$treeview
14+
$search
15+
$mathjax
16+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
17+
$extrastylesheet
18+
</head>
19+
<body>
20+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
21+
22+
<!--BEGIN TITLEAREA-->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<!--BEGIN PROJECT_LOGO-->
28+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
29+
<!--END PROJECT_LOGO-->
30+
<!--BEGIN PROJECT_NAME-->
31+
<td style="padding-left: 0.5em;">
32+
<div id="projectname">$projectname
33+
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
34+
</div>
35+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
36+
</td>
37+
<!--END PROJECT_NAME-->
38+
<!--BEGIN !PROJECT_NAME-->
39+
<!--BEGIN PROJECT_BRIEF-->
40+
<td style="padding-left: 0.5em;">
41+
<div id="projectbrief">$projectbrief</div>
42+
</td>
43+
<!--END PROJECT_BRIEF-->
44+
<!--END !PROJECT_NAME-->
45+
<!--BEGIN DISABLE_INDEX-->
46+
<!--BEGIN SEARCHENGINE-->
47+
<td>$searchbox</td>
48+
<!--END SEARCHENGINE-->
49+
<!--END DISABLE_INDEX-->
50+
</tr>
51+
</tbody>
52+
</table>
53+
</div>
54+
<!--END TITLEAREA-->
55+
<!-- end header part -->

0 commit comments

Comments
 (0)