Skip to content

Commit 6b58adc

Browse files
gigapodgigapod
committed
continued work/exploration of building and organizing docs via doxygen
1 parent e8faae3 commit 6b58adc

File tree

7 files changed

+3292
-70
lines changed

7 files changed

+3292
-70
lines changed

‎docs/doxygen/doxygen-awesome-css

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

‎docs/doxygen/doxygen-config

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

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

Lines changed: 21 additions & 0 deletions
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

Lines changed: 123 additions & 0 deletions
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

‎docs/properties.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
\defgroup module_properties Properties
2+
@{
13

24
# Properties
35

@@ -22,10 +24,10 @@ The following types are available for properties
2224
* bool
2325
* int8
2426
* int16
25-
* int
27+
* int32
2628
* uint8
2729
* uint16
28-
* uint
30+
* uint32
2931
* float
3032
* double
3133
* string
@@ -59,7 +61,7 @@ For the framework, two types of property classes exist.
5961

6062
For each of the above types, besides _normal_ property types that are visible and stored as is, there are three different attributes available:
6163

62-
* Hidden - ```flxPropertyHidden<type>```, ```flxPropertyRWHidden<type>``` - The property isn't presented in menu systems, but can be used by an object to store/persist it's value.
64+
* Hidden - ```flxPropertyHidden<type>```, ```flxPropertyRWHidden<type>``` - The property isn't presented in menu systems, but can be used by an object to store/persist it's value.
6365
* Secure - ```flxPropertySecure<type>```, ```flxPropertyRWSecure<type>``` -The value of the property is encrypted before saving the value. This value is only written internally (not to a public JSON file)
6466
* Secret - ```flxPropertySecret<type>```, ```flxPropertyRWSecret<type>``` - The value is _hidden_ and _secure_.
6567

@@ -85,10 +87,10 @@ Available Property Types:
8587
* flxPropertyBool
8688
* flxPropertyInt8
8789
* flxPropertyInt16
88-
* flxPropertyInt
89-
* flxPropertyUint8
90-
* flxPropertyUint16
91-
* flxPropertyUint
90+
* flxPropertyInt32
91+
* flxPropertyUInt8
92+
* flxPropertyUInt16
93+
* flxPropertyUInt32
9294
* flxPropertyFloat
9395
* flxPropertyDouble
9496
* flxPropertyString
@@ -176,10 +178,10 @@ Where:
176178
* flxPropertyRWBool - bool property
177179
* flxPropertyRWInt8 - integer 8 property
178180
* flxPropertyRWInt16 - integer 16 property
179-
* flxPropertyRWInt - integer property
180-
* flxPropertyRWUint8 - unsigned 8 integer
181-
* flxPropertyRWUint16 - unsigned 16 integer
182-
* flxPropertyRWUint - unsigned integer
181+
* flxPropertyRWInt32 - integer 32 property
182+
* flxPropertyRWUInt8 - unsigned 8 integer
183+
* flxPropertyRWUInt16 - unsigned 16 integer
184+
* flxPropertyRWUInt32 - unsigned 32 integer
183185
* flxPropertyRWFloat - float
184186
* flxPropertyRWDouble - double
185187
* flxPropertyRWString - string -> std::string
@@ -274,7 +276,7 @@ Note: If an initial value was set for the property, the value is passed to the _
274276

275277
Data limits define restrictions on the values the input parameter accepts. There are two types of data limits: range and valid value sets.
276278

277-
*Data Range*
279+
_Data Range_
278280
This represents the minimum and maximum values a input parameter will accept. The values can be specified at property definition (the preferred method) and also set at runtime.
279281

280282
To set the range at parameter definition, just set the declared parameter to the range using a C++ initializer list ```{ min, max}```
@@ -311,7 +313,7 @@ For Example:
311313

312314
This changes the data range accepted by the object and deletes any existing data limit.
313315

314-
*Data Valid Value Set*
316+
_Data Valid Value Set_
315317

316318
This represents data limit provides a defined set of valid values for the property. The limit is defined by a set of _name, value_ pairs that enable a human readable presentation for the values a property will accept. The values can be specified at property definition and also set at runtime.
317319

@@ -367,3 +369,5 @@ Or for an entire parameter list:
367369
```
368370
369371
The values are added to the current valid value list. If a _ValidValue_ data limit was not in place when called, any current limit (i.e. range limit) is deleted and a valid value limit is put in place.
372+
373+
@}

0 commit comments

Comments
 (0)