wip ci

.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: API documentation generation
+
+on:
+ push:
+ branches:
+ - generate-api-doc
+
+permissions:
+ pages: write
+ id-token: write
+
+jobs:
+ doc:
+ runs-on: ubuntu-latest
+ container: hrektts/doxygen
+ steps:
+ - uses: actions/checkout@v3
+ - run: |
+ doxygen doc/doxygen.cfg
+ mv html _site
+ mv _site/group__uprofile.html _site/index.html
+ name: Generate doc
+ - name: Upload Pages artifact
+ uses: actions/upload-pages-artifact@v2
+ - name: Deploy to GitHub Pages
+ uses: actions/deploy-pages@v2

lib/uprofile.h

@@ -58,7 +58,7 @@ UPROFAPI void start(const char* file);
  * @ingroup uprofile
  * @brief Stop all monitorings
  *
- * Note: stopping profiler on an no-started profiler has no effect
+ * Note: stopping profiler without prior call to start() has no effect
  */
 UPROFAPI void stop();
 
@@ -153,7 +153,7 @@ UPROFAPI void getSystemMemory(int& totalMem, int& availableMem, int& freeMem);
 /**
  * @ingroup uprofile
  * @brief get usage of all cpu cores
- * @return vector of percentage
+ * @return vector holding the usage percentage of each CPU core
  */
 UPROFAPI std::vector<float> getInstantCpuUsage();
 }