]> git.seodisparate.com - UDPConnection/commitdiff
Update README.md
authorStephen Seo <seo.disparate@gmail.com>
Mon, 13 Jan 2020 09:50:00 +0000 (18:50 +0900)
committerStephen Seo <seo.disparate@gmail.com>
Mon, 13 Jan 2020 09:50:00 +0000 (18:50 +0900)
README.md

index 1a412ae6183d3077f2a583faffa892019a2f61f3..417be99c157a1821251fa0b64628f649da3a0d0c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,11 @@ should facilitate creating bindings for other programming languages if needed.
 This library is still a work in progress, so api breaking changes may happen
 in the future.
 
+## Documentation
+
+`src/UDPC.h` is documented with Doxygen style comments. The doxygen docs can be
+created by invoking `doxygen Doxyfile` in the root directory of the project.
+
 ## Compiling
 
     mkdir buildRelease