From 747a94d1d9f853949a3a60ceb4afd7d23ca744c5 Mon Sep 17 00:00:00 2001 From: Rene Bartsch Date: Fri, 29 Jun 2018 18:56:49 +0200 Subject: [PATCH] Created Source code documentation (markdown) --- Source-code-documentation.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 Source-code-documentation.md diff --git a/Source-code-documentation.md b/Source-code-documentation.md new file mode 100644 index 00000000..e886a3a1 --- /dev/null +++ b/Source-code-documentation.md @@ -0,0 +1,5 @@ +# Generating source code documentation +Tasmota ships with a configuration file (Doxyfile) for the [Doxygen](http://www.stack.nl/~dimitri/doxygen/) source code documentation generator. Just [install Doxygen](http://www.stack.nl/%7Edimitri/doxygen/download.html#srcbin), [install GraphViz](https://www.graphviz.org/download/) and run updateDocs.sh to generate the source code documentation. + +# Creating source code documenation +See the [Doxygen manual](http://www.stack.nl/%7Edimitri/doxygen/manual/docblocks.html#cppblock) \ No newline at end of file