Merge pull request #2 from ika-rwth-aachen/feature/doxygen

Add Doxygen documentation for access functions

.github/workflows/doc.yml

@@ -0,0 +1,23 @@
+name: Documentation
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Run Doxygen
+        uses: mattnotmitt/[email protected]
+        with:
+          working-directory: doc
+          doxyfile-path: Doxyfile
+      - name: Publish to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: doc/html

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "denm_en302637_3"]
 	path = asn1/raw/denm_en302637_3
 	url = https://forge.etsi.org/rep/ITS/asn1/denm_en302637_3.git
+[submodule "doc/doxygen-awesome-css"]
+	path = doc/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git

README.md

@@ -5,6 +5,7 @@
   <img src="https://img.shields.io/github/license/ika-rwth-aachen/etsi_its_messages"/>
   <a href="https://github.com/ika-rwth-aachen/etsi_its_messages/actions/workflows/codegen.yml"><img src="https://github.com/ika-rwth-aachen/etsi_its_messages/actions/workflows/codegen.yml/badge.svg"/></a>
   <a href="https://github.com/ika-rwth-aachen/etsi_its_messages/actions/workflows/docker-ros.yml"><img src="https://github.com/ika-rwth-aachen/etsi_its_messages/actions/workflows/docker-ros.yml/badge.svg"/></a>
+  <a href="https://github.com/ika-rwth-aachen/etsi_its_messages/actions/workflows/doc.yml"><img src="https://github.com/ika-rwth-aachen/etsi_its_messages/actions/workflows/doc.yml/badge.svg"/></a>
   <img src="https://img.shields.io/badge/ROS-noetic-blueviolet"/>
   <img src="https://img.shields.io/badge/ROS 2-humble|iron|rolling-blueviolet"/>
 </p>
@@ -29,6 +30,7 @@ All message definitions and conversion functions are automatically generated bas
   - [Packages](#packages)
     - [`etsi_its_msgs`](#etsi_its_msgs)
       - [Automated Generation](#automated-generation)
+      - [Access Functions Documentation](#access-functions-documentation)
     - [`etsi_its_coding`](#etsi_its_coding)
       - [Automated Generation](#automated-generation-1)
     - [`etsi_its_conversion`](#etsi_its_conversion)
@@ -104,6 +106,17 @@ The ROS message files are auto-generated based on the [ASN.1 definitions](https:
   -o etsi_its_msgs/etsi_its_cam_msgs/msg
 ```
 
+#### Access Functions Documentation
+
+[Click here](https://ika-rwth-aachen.github.io/etsi_its_messages) to be taken to the API documentation for the implemented access functions.
+
+The documentation can be generated by running [Doxygen](https://doxygen.nl/).
+
+```bash
+# etsi_its_messages/doc$
+doxygen
+```
+
 ### `etsi_its_coding`
 
 The `etsi_its_coding` metapackage includes one dedicated package for each ETSI ITS message type, e.g., `etsi_its_cam_coding`. These packages provide C++ libraries containing a `struct` implementation of the ETSI ITS message types including functions for encoding and decoding the structures to binary buffers.

doc/.gitignore

@@ -0,0 +1 @@
+html/