Dev

.github/workflows/ci.yml

@@ -187,11 +187,17 @@ jobs:
     - name: Install Doxygen
       run: |
         sudo apt-get update
-        sudo apt-get install -y doxygen graphviz
+        sudo apt-get install -y doxygen graphviz plantuml default-jre
 
     - name: Generate documentation
       run: |
         doxygen --version
+        # Render PlantUML diagrams to SVG before running Doxygen (so Doxygen can include pre-rendered images)
+        for p in doc/diagrams/*.puml; do
+          if [ -f "$p" ]; then
+            plantuml -tsvg -o doc/diagrams "${p}"
+          fi
+        done
         doxygen Doxyfile
       working-directory: ${{ github.workspace }}
     - name: List generated docs

Doxyfile

@@ -114,6 +114,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 INPUT                  = inc \
                          src \
+                         doc \
                          README.md
 INPUT_ENCODING         = UTF-8
 INPUT_FILE_ENCODING    =
@@ -140,7 +141,7 @@ EXAMPLE_PATH           = examples
 EXAMPLE_PATTERNS       = *.cpp \
                          *.h
 EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             =
+IMAGE_PATH             = doc/diagrams
 INPUT_FILTER           =
 FILTER_PATTERNS        =
 FILTER_SOURCE_FILES    = NO
@@ -307,7 +308,7 @@ DOT_PATH               =
 DOTFILE_DIRS           =
 DIA_PATH               =
 DIAFILE_DIRS           =
-PLANTUML_JAR_PATH      =
+PLANTUML_JAR_PATH      = /usr/share/plantuml/plantuml.jar
 PLANTUML_CFG_FILE      =
 PLANTUML_INCLUDE_PATH  =
 DOT_GRAPH_MAX_NODES    = 50

README.md

@@ -11,9 +11,6 @@ C/C++ library for Diagnostics over IP (DoIP) (fork from https://github.com/AVL-D
 
 **CAUTION** The current API is under construction any may change at any time.
 
-
-
-
 ## Dependencies
 
 `libdoip` uses `spdlog`. The lib is downloaded automatically. Or you may install it locally via
@@ -25,18 +22,20 @@ sudo apt install libspdlog-dev
 
 See [Logging](./doc/LOGGING.md) for details.
 
-### Building Documentation Locally
+### Getting started
+
+Quick start — read the generated tutorial for the example server:
 
-To generate the documentation locally:
+- Online (published): https://magolves.github.io/libdoip/index.html
+- Local example page: see `doc/ExampleDoIPServer.md` (included in the Doxygen HTML under "Example DoIP Server Tutorial").
+- Example tutorial (direct): https://magolves.github.io/libdoip/ExampleDoIPServer.html
+
+If you want to generate the docs locally, install Doxygen and Graphviz and
+run:
 
 ```bash
-# Install Doxygen and Graphviz
 sudo apt install doxygen graphviz
-
-# Generate documentation
 doxygen Doxyfile
-
-# Open the documentation
 xdg-open docs/html/index.html
 ```
 
@@ -76,7 +75,22 @@ sudo apt install doctest
 sudo tcpdump -i any udp port 13400 -X
 ```
 
+## Examples
+
+The project includes a small example DoIP server demonstrating how to
+use the `DoIPServer` and `DoIPServerModel` APIs and how to register UDS
+handlers.
+
+- Example source files: `examples/exampleDoIPServer.cpp`,
+  `examples/ExampleDoIPServerModel.h`
+- Example tutorial (published): https://magolves.github.io/libdoip/ExampleDoIPServer.html
+
+See the "Examples" section in the generated Doxygen main page for
+additional annotated links to these files.
+
+
 ## References
+
 - [ISO 13400-2:2019(en) Road vehicles — Diagnostic communication over Internet Protocol (DoIP) — Part 2: Transport protocol and network layer services](<https://www.iso.org/obp/ui/#iso:std:iso:13400:-2:ed-2:v1:en>)
 - [Specification of Diagnostic over IP](<https://www.autosar.org/fileadmin/standards/R20-11/CP/AUTOSAR_SWS_DiagnosticOverIP.pdf>)
 - [Diagnostics over Internet Protocol (DoIP)](<https://cdn.vector.com/cms/content/know-how/_application-notes/AN-IND-1-026_DoIP_in_CANoe.pdf>)