continued work on docs concept

gigapod · gigapod · commit 54b4c9ff5d83 · 2024-05-01T17:54:39.000-06:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+
+docs/html/
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs/doxygen/doxygen-awesome-css"]
+	path = docs/doxygen/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git
diff --git a/docs/doxygen/doxygen-config b/docs/doxygen/doxygen-config
@@ -949,9 +949,10 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src \
-                         README.md \
-                         docs
+INPUT                  =    docs/flux.dox \
+                            docs \
+                            src \
+                            README.md 
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -2466,7 +2467,7 @@ HIDE_UNDOC_RELATIONS   = YES
 # set to NO
 # The default value is: NO.
 
-HAVE_DOT               = YES
+HAVE_DOT               = NO
 
 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
 # to run in parallel. When set to 0 doxygen will base this on the number of
diff --git a/docs/doxygen/doxygen-custom/header.html b/docs/doxygen/doxygen-custom/header.html
@@ -38,7 +38,7 @@
 <body>
 
     <!-- https://tholman.com/github-corners/ -->
-    <a href="https://github.com/sparkfun/SparkFun_Toolkit" class="github-corner" title="View source on GitHub">
+    <a href="https://github.com/sparkfun/flux-sdk" class="github-corner" title="View source on GitHub">
         <svg viewBox="0 0 250 250" style="position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true">
             <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
             <path
diff --git a/docs/flux.dox b/docs/flux.dox
@@ -0,0 +1,23 @@
+/**
+ * @defgroup core Core
+ @brief Core Module of the SDK
+ */
+
+/**
+ * @defgroup module_properties Properties
+   @brief Using and developing with object properties 
+ * @ingroup core
+ */
+
+
+/**
+ * @defgroup property_rw_classes Read/Write Property Classes
+ * @brief Read/Write Property Class Definitions
+ * @ingroup module_properties
+ */
+
+ /**
+  * @defgroup property_classes Property Classes
+    @brief Property Class Definitions
+  * @ingroup module_properties
+  */
diff --git a/docs/properties.md b/docs/properties.md
@@ -1,4 +1,4 @@
-\defgroup module_properties Properties
+\addtogroup module_properties
 @{
 
 # Properties
@@ -7,7 +7,7 @@ Properties represent the "_settings_" for a particular object within the system.
 
 It's worth noting that properties don't reflect the input or output data from an object within the framework - this managed by _parameter_ objects.
 
-### Property Attributes
+## Property Attributes
 
 The following are key attributes of properties within the framework
 
@@ -17,7 +17,7 @@ The following are key attributes of properties within the framework
 * Property objects can act like a variable
 * Property objects allow introspection - they can be discovered and manipulated at runtime via software
 
-#### Property Types
+### Property Types
 
 The following types are available for properties
 
@@ -178,7 +178,7 @@ Where:
 * flxPropertyRWBool - bool property
 * flxPropertyRWInt8  - integer 8 property
 * flxPropertyRWInt16  - integer 16 property
-* flxPropertyRWInt32  - integer 32 property
+* flxPropertyRWInt32  - integer3 property
 * flxPropertyRWUInt8 - unsigned 8 integer
 * flxPropertyRWUInt16 - unsigned 16 integer
 * flxPropertyRWUInt32 - unsigned 32 integer
diff --git a/src/core/flux_base/flxCoreProps.h b/src/core/flux_base/flxCoreProps.h
@@ -716,10 +716,8 @@ class _flxPropertyTypedRW : public _flxPropertyBase<T, HIDDEN, SECURE>
 
 // Create typed read/writer property objects - type and RW objects as super classes
 /**
- * @defgroup property_rw_classes Read/Write Property Classes
- *
+ * @addtogroup property_rw_classes
  * @{
- * @ingroup module_properties
  */
 
 /**
@@ -1615,10 +1613,8 @@ class _flxPropertyTyped : public _flxPropertyBase<T, HIDDEN, SECURE>
 // Define typed properties
 
 /**
- * @defgroup property_classes Property Classes
- *
+ * @addtogroup property_classes
  * @{
- * @ingroup module_properties
  */
 
 /**
diff --git a/src/core/flux_base/flxCoreTypes.h b/src/core/flux_base/flxCoreTypes.h
@@ -51,7 +51,7 @@ class flxDescriptor
      * @brief Set the Name object  - storing the pointer to the provided string No allocation is
      * performed. If the previous name was allocated, it is freed.
      *
-     * @param new_name[in] The new name for the object
+     * @param[in] new_name The new name for the object
      */
 
     void setName(const char *new_name)
@@ -1023,7 +1023,7 @@ class flxDataOut
      * @param bool value
      * @return value as a bool
      */
-    bool get_value(bool)
+    bool get_value(bool b)
     {
         return getBool();
     }
diff --git a/src/core/flux_base/flxUtils.cpp b/src/core/flux_base/flxUtils.cpp
@@ -430,8 +430,8 @@ void flx_utils::formatByteString(uint64_t nBytes, uint prec, char *szBuffer, siz
 /// createVariableName()
 ///
 /// @brief     Creates a valid arduino variable name
-/// @param[In] szInVariable the name to convert
-/// @param[Out] szOutVariable the converted name - assumed to same len as in variable.
+/// @param[in] szInVariable the name to convert
+/// @param[out] szOutVariable the converted name - assumed to same len as in variable.
 ///
 /// @return true on success, false on failure
 ///
diff --git a/src/iot/iot_arduino/flxIoTArduino.h b/src/iot/iot_arduino/flxIoTArduino.h
@@ -204,7 +204,7 @@ class DataLoggerAIOTConnectionHandler : public ConnectionHandler
 //
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-/// @typedef flxIoTArduinoVar_t
+/// @struct flxIoTArduinoVar_t
 /// @brief Struct to hold a dynamically created Arduino Cloud variable
 ///
 typedef struct

Original file line number	Diff line number	Diff 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`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ class flxDescriptor`
`51`	`51`	`* @brief Set the Name object - storing the pointer to the provided string No allocation is`
`52`	`52`	`* performed. If the previous name was allocated, it is freed.`
`53`	`53`	`*`
`54`		`- * @param new_name[in] The new name for the object`
	`54`	`+ * @param[in] new_name The new name for the object`
`55`	`55`	`*/`
`56`	`56`
`57`	`57`	`void setName(const char *new_name)`
`@@ -1023,7 +1023,7 @@ class flxDataOut`
`1023`	`1023`	`* @param bool value`
`1024`	`1024`	`* @return value as a bool`
`1025`	`1025`	`*/`
`1026`		`- bool get_value(bool)`
	`1026`	`+ bool get_value(bool b)`
`1027`	`1027`	`{`
`1028`	`1028`	`return getBool();`
`1029`	`1029`	`}`