From fb82f1cf8049e2364ea9860b85d1761ce597057a Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Mon, 22 Oct 2012 11:57:49 +0200 Subject: [PATCH] doxygen now recognizes README and .txt files The default doxygen configuration file only accepts source files such as php or python. Some of our documentation is in flat files which we might want to include in our Doxygen inline documentation. The culprit is that those document files needs to respect Doxygen syntax, i.e. the text content need to be enclosed in a comment block such as: /*! \page page_title My Page Title My awesome documentation */ Doyxgen 1.8 supports markdown syntax, we might want to switch to that eventually. Change-Id: I78a0ce36314b2a7b9f89395e3ae3902b17cf5038 --- maintenance/Doxyfile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/maintenance/Doxyfile b/maintenance/Doxyfile index e3ba4e5a1d..34e66e52e0 100644 --- a/maintenance/Doxyfile +++ b/maintenance/Doxyfile @@ -171,7 +171,9 @@ FILE_PATTERNS = *.c \ *.PHP5 \ *.M \ *.MM \ - *.PY + *.PY \ + *.txt \ + README RECURSIVE = YES EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE_PATTERNS}} -- 2.20.1