Added initial documentation

2023-01-01 20:36:58 +01:00
parent 9d7275e388
commit e4a29c7117
15 changed files with 1328 additions and 137 deletions
--- a/docs/doxygen_integration.md
+++ b/docs/doxygen_integration.md
@@ -0,0 +1,14 @@
+# Doxygen integration
+
+`clang-uml` diagrams can be easily added to the Doxygen documentation using the image tag, however
+[Doxygen](https://www.doxygen.nl/index.html) does not support the `clang-uml` specific commands.
+
+`clang-uml` decorators can be omitted completely in Doxygen, by adding the
+following lines to the Doxygen config file:
+
+```
+ALIASES                += uml=""
+ALIASES                += uml{1}=""
+ALIASES                += uml{2}=""
+ALIASES                += uml{3}=""
+```