Skip to content

Commit d702c0c

Browse files
gigapodgigapod
committed
Core of Doxygen support working
Generates core site - building manually. Generating SDK/API docs.
1 parent e8d3f14 commit d702c0c

14 files changed

+3197
-156
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# VSCode directories
22
.vscode
33

4+
5+
docs/html/

‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/doxygen/doxygen-awesome-css"]
2+
path = docs/doxygen/doxygen-awesome-css
3+
url = https://github.com/jothepro/doxygen-awesome-css.git

‎docs/doxygen/doxygen-awesome-css

Submodule doxygen-awesome-css added at 9f97817

‎docs/doxygen/doxygen-config

+2,818
Large diffs are not rendered by default.

‎docs/doxygen/doxygen-custom/custom.css

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:root {
2+
--side-nav-fixed-width: 300px;
3+
}
4+
5+
.github-corner svg {
6+
fill: var(--primary-light-color);
7+
color: var(--page-background-color);
8+
width: 72px;
9+
height: 72px;
10+
}
11+
12+
#projectnumber {
13+
margin-right: 22px;
14+
}
15+
16+
@media screen and (max-width: 767px) {
17+
.github-corner svg {
18+
width: 55px;
19+
height: 55px;
20+
}
21+
}

‎docs/doxygen/doxygen-custom/header.html

+123
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<!-- HTML header for doxygen 1.9.1-->
2+
<!DOCTYPE html
3+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
<html xmlns="http://www.w3.org/1999/xhtml">
5+
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
8+
<meta http-equiv="X-UA-Compatible" content="IE=9" />
9+
<meta name="generator" content="Doxygen $doxygenversion" />
10+
<meta name="viewport" content="width=device-width, initial-scale=1" />
11+
12+
<!-- BEGIN opengraph metadata -->
13+
<meta property="og:title" content="SparkFun Toolkit" />
14+
<meta property="og:description" content="Common Functionality for Arduino Libraries" />
15+
<meta property="og:url" content="https://docs.sparkfun.com/SparkFun_Toolkit/" />
16+
<!-- END opengraph metadata -->
17+
18+
<!-- BEGIN twitter metadata -->
19+
<meta name="twitter:title" content="SparkFun Toolkit" />
20+
<meta name="twitter:description" content="Common Functionality for Arduino Libraries." />
21+
<!-- END twitter metadata -->
22+
23+
<!--BEGIN PROJECT_NAME-->
24+
<title>$projectname: $title</title><!--END PROJECT_NAME-->
25+
<!--BEGIN !PROJECT_NAME-->
26+
<title>$title</title><!--END !PROJECT_NAME-->
27+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css" />
28+
<link rel="icon" type="image/png" href="sfe_flame.png">
29+
<script type="text/javascript" src="$relpath^jquery.js"></script>
30+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
31+
$treeview
32+
$search
33+
$mathjax
34+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
35+
$extrastylesheet
36+
</head>
37+
38+
<body>
39+
40+
<!-- https://tholman.com/github-corners/ -->
41+
<a href="https://github.com/sparkfun/SparkFun_Toolkit" class="github-corner" title="View source on GitHub">
42+
<svg viewBox="0 0 250 250" style="position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true">
43+
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
44+
<path
45+
d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
46+
fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
47+
<path
48+
d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
49+
fill="currentColor" class="octo-body"></path>
50+
</svg></a>
51+
<style>
52+
.github-corner:hover .octo-arm {
53+
animation: octocat-wave 560ms ease-in-out
54+
}
55+
56+
@keyframes octocat-wave {
57+
58+
0%,
59+
100% {
60+
transform: rotate(0)
61+
}
62+
63+
20%,
64+
60% {
65+
transform: rotate(-25deg)
66+
}
67+
68+
40%,
69+
80% {
70+
transform: rotate(10deg)
71+
}
72+
}
73+
74+
@media (max-width:500px) {
75+
.github-corner:hover .octo-arm {
76+
animation: none
77+
}
78+
79+
.github-corner .octo-arm {
80+
animation: octocat-wave 560ms ease-in-out
81+
}
82+
}
83+
</style>
84+
85+
86+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
87+
88+
<!--BEGIN TITLEAREA-->
89+
<div id="titlearea">
90+
<table cellspacing="0" cellpadding="0">
91+
<tbody>
92+
<tr style="height: 56px;">
93+
<!--BEGIN PROJECT_LOGO-->
94+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo" /></td>
95+
<!--END PROJECT_LOGO-->
96+
<!--BEGIN PROJECT_NAME-->
97+
<td id="projectalign" style="padding-left: 0.5em;">
98+
<div id="projectname">$projectname
99+
<!--BEGIN PROJECT_NUMBER-->&#160;<span
100+
id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
101+
</div>
102+
<!--BEGIN PROJECT_BRIEF-->
103+
<div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
104+
</td>
105+
<!--END PROJECT_NAME-->
106+
<!--BEGIN !PROJECT_NAME-->
107+
<!--BEGIN PROJECT_BRIEF-->
108+
<td style="padding-left: 0.5em;">
109+
<div id="projectbrief">$projectbrief</div>
110+
</td>
111+
<!--END PROJECT_BRIEF-->
112+
<!--END !PROJECT_NAME-->
113+
<!--BEGIN DISABLE_INDEX-->
114+
<!--BEGIN SEARCHENGINE-->
115+
<td>$searchbox</td>
116+
<!--END SEARCHENGINE-->
117+
<!--END DISABLE_INDEX-->
118+
</tr>
119+
</tbody>
120+
</table>
121+
</div>
122+
<!--END TITLEAREA-->
123+
<!-- end header part -->

‎docs/images/sfe_flame.png

3.74 KB
Loading

‎src/sfeTk/sfeTkError.h

+27-20
Original file line numberDiff line numberDiff line change
@@ -26,32 +26,39 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2626

2727
#pragma once
2828

29-
3029
#include <stdint.h>
3130

32-
//
33-
// General Concept
34-
// A SparkFun Toolkit error system. The goal is to keep this simple.
35-
//
36-
// This mimics a vareity of systems, using an int type for error codes,
37-
// where:
38-
// 0 = okay
39-
// -1 = general failure
40-
// >0 = an informative error
41-
//
42-
// Since *subsystems* in the toolkit can have their own errors,
43-
// A start range for these errors are defined. Values > than this value
44-
// define the errors for the set subsystem. These start ranges are set
45-
// in this file, with actual error values defined in the the respective
46-
// subsystem header files.
47-
//
48-
// Define our error codes/type
31+
/**
32+
* General Concept
33+
* A SparkFun Toolkit error system. The goal is to keep this simple.
34+
*
35+
* This mimics a vareity of systems, using an int type for error codes,
36+
* where:
37+
* 0 = okay
38+
* -1 = general failure
39+
* >0 = an informative error
40+
*
41+
* Since *subsystems* in the toolkit can have their own errors,
42+
* A start range for these errors are defined. Values > than this value
43+
* define the errors for the set subsystem. These start ranges are set
44+
* in this file, with actual error values defined in the the respective
45+
* subsystem header files.
46+
*
47+
*/
4948
typedef int32_t sfeTkError_t;
5049

5150
// General errors
5251

52+
/**
53+
* @brief General error code for a failure. Note all errors are negative.
54+
*/
5355
const sfeTkError_t kSTkErrFail = -1; // general fail
54-
const sfeTkError_t kSTkErrOk = 0; // success
56+
/**
57+
* @brief The error code value for success. This is always 0.
58+
*/
59+
const sfeTkError_t kSTkErrOk = 0; // success
5560

56-
// Base error number for IBus/Bus operations Bus errors are not less than this.
61+
/**
62+
* @brief A base value for bus errors. All bus errors are greater than this value, in the 1000 range
63+
*/
5764
const sfeTkError_t kSTkErrBaseBus = 0x1000;

0 commit comments

Comments
 (0)