From a50b3ac28b9a8c37aedbb3ea69f2c9406119fcc8 Mon Sep 17 00:00:00 2001 From: Johannes Blaschke Date: Thu, 22 Mar 2018 17:59:25 -0700 Subject: [PATCH] explain doxygen design pattern --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 23fdf3b..3652b64 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,11 @@ Do not push any edits to the `gh-pages` branch as these will be overwritten. Instead, commit your changes to the `master` branch, and the `gh-pages` branch will be updated automatially a few minutes later. The documentation source is in `docs/source/` and the html source for the cover page is in `docs/webroot/`. + +### Doxygen + +Whenever the online documentation is updated, a fresh doxygen will be generated +also. Note that the configuration in `docs/doxygen/doxygen.conf` specifically +prevent source code from being displayed. This is by design. If you want to +create your own private doxygen containing the source code also, please +configure and run the `doc/Doxyfile.in` in your clone of the MFiX-Exa repo. -- GitLab