doxygen now recognizes README and .txt files
authorAntoine Musso <hashar@free.fr>
Mon, 22 Oct 2012 09:57:49 +0000 (11:57 +0200)
committerAntoine Musso <hashar@free.fr>
Mon, 22 Oct 2012 09:58:53 +0000 (11:58 +0200)
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

index e3ba4e5..34e66e5 100644 (file)
@@ -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}}