Update Docs

Author: Jakub Smejkal

.github/workflows/docs.yaml

@@ -3,21 +3,24 @@ on:
   push:
     branches:
       - main
-  workflow_dispatch:
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+      with:
+        path: 'chester-sdk'
     - uses: actions/checkout@v2
       with:
         repository: 'jothepro/doxygen-awesome-css'
-        path: 'doc/doxygen-awesome-css'
+        path: 'doxygen-awesome-css'
     - name: Build docs
       uses: mattnotmitt/[email protected]
+      with:
+        working-directory: 'chester-sdk'
     - name: Deploy
       uses: peaceiris/actions-gh-pages@v3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./doc/html
+        publish_dir: ./chester-sdk/doc/html
 

Doxyfile

@@ -440,7 +440,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,
@@ -1172,8 +1172,8 @@ HTML_STYLESHEET        =
 # list). For an example see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = doc/doxygen-awesome-css/doxygen-awesome.css \
-	doc/doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
+HTML_EXTRA_STYLESHEET  = ../doxygen-awesome-css/doxygen-awesome.css \
+	../doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
 	doc/custom.css
 HTML_COLORSTYLE = LIGHT
 

include/chester/drivers/ctr_x0.h

@@ -15,13 +15,21 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup ctr_x0 ctr_x0
+ * @brief Driver for CHESTER X0
+ * @{
+ */
+
+/** @brief Channels */
 enum ctr_x0_channel {
 	CTR_X0_CHANNEL_1 = 0,
 	CTR_X0_CHANNEL_2 = 1,
 	CTR_X0_CHANNEL_3 = 2,
 	CTR_X0_CHANNEL_4 = 3,
 };
 
+/** @brief Modes */
 enum ctr_x0_mode {
 	CTR_X0_MODE_DEFAULT = 0,
 	CTR_X0_MODE_NPN_INPUT = 1,
@@ -31,16 +39,25 @@ enum ctr_x0_mode {
 	CTR_X0_MODE_PWR_SOURCE = 5,
 };
 
+/** @private */
 typedef int (*ctr_x0_api_set_mode)(const struct device *dev, enum ctr_x0_channel channel,
 				   enum ctr_x0_mode mode);
+/** @private */
 typedef int (*ctr_x0_api_get_spec)(const struct device *dev, enum ctr_x0_channel channel,
 				   const struct gpio_dt_spec **spec);
 
+/** @private */
 struct ctr_x0_driver_api {
 	ctr_x0_api_set_mode set_mode;
 	ctr_x0_api_get_spec get_spec;
 };
 
+/**
+ * @brief Set mode
+ * @param[in] dev
+ * @param[in] channel Channel to modify
+ * @param[in] mode
+ */
 static inline int ctr_x0_set_mode(const struct device *dev, enum ctr_x0_channel channel,
 				  enum ctr_x0_mode mode)
 {
@@ -49,6 +66,12 @@ static inline int ctr_x0_set_mode(const struct device *dev, enum ctr_x0_channel
 	return api->set_mode(dev, channel, mode);
 }
 
+/**
+ * @brief Get channel's GPIO device tree spec
+ * @param[in] dev
+ * @param[in] channel
+ * @param[out] spec
+ */
 static inline int ctr_x0_get_spec(const struct device *dev, enum ctr_x0_channel channel,
 				  const struct gpio_dt_spec **spec)
 {
@@ -57,6 +80,8 @@ static inline int ctr_x0_get_spec(const struct device *dev, enum ctr_x0_channel
 	return api->get_spec(dev, channel, spec);
 }
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

scripts/gen-msg-key.py

@@ -14,27 +14,37 @@
 import sys
 
 def main():
-    decoder = yaml.load(open(sys.argv[1]), Loader=yaml.FullLoader)
-
-    with open(sys.argv[2], 'w') as f:
-        f.write('#ifndef MSG_KEY_H_\n')
-        f.write('#define MSG_KEY_H_\n\n')
-        f.write('/* This file has been generated using the script gen-msg-key.py */\n\n')
-        f.write('#ifdef __cplusplus\n')
-        f.write('extern "C" {\n')
-        f.write('#endif\n\n')
-        f.write('enum msg_key {\n')
-
-        for i, item in enumerate(decoder):
-            key, _ = item.popitem()
-            f.write(f'\tMSG_KEY_{key.upper()} = {i},\n')
-
-        f.write('};\n\n')
-        f.write('#ifdef __cplusplus\n')
-        f.write('}\n')
-        f.write('#endif\n\n')
-
-        f.write('#endif /* MSG_KEY_H_ */\n')
+    inp = sys.stdin
+    out = sys.stdout
+    if len(sys.argv) == 3:
+        inp = open(sys.argv[1])
+        out = open(sys.argv[2], 'w')
+
+    decoder = yaml.load(inp, Loader=yaml.FullLoader)
+
+    out.write('#ifndef MSG_KEY_H_\n')
+    out.write('#define MSG_KEY_H_\n\n')
+    out.write('/* This file has been generated using the script gen-msg-key.py */\n\n')
+    out.write('#ifdef __cplusplus\n')
+    out.write('extern "C" {\n')
+    out.write('#endif\n\n')
+    out.write('enum msg_key {\n')
+
+    for i, item in enumerate(decoder):
+        key, _ = item.popitem()
+        out.write(f'\tMSG_KEY_{key.upper()} = {i},\n')
+
+    out.write('};\n\n')
+    out.write('#ifdef __cplusplus\n')
+    out.write('}\n')
+    out.write('#endif\n\n')
+
+    out.write('#endif /* MSG_KEY_H_ */\n')
+
+    if len(sys.argv) == 3:
+        inp.close()
+        out.close()
+
 
 if __name__ == '__main__':
     main()

west.yml

@@ -9,6 +9,9 @@ manifest:
       repo-path: ncs.git
       revision: v2.5-chester-branch
       import: true
+    - name: doxygen-awesome-css
+      url: https://github.com/jothepro/doxygen-awesome-css
+      revision: main
   self:
     path: chester
     west-commands: scripts/west-commands.yml