diff options
| author | Yann Herklotz <ymherklotz@gmail.com> | 2017-08-24 19:24:34 +0100 |
|---|---|---|
| committer | Yann Herklotz <ymherklotz@gmail.com> | 2017-08-24 19:38:09 +0100 |
| commit | 05685988739382343031b1fb2c94b74699f4ff7e (patch) | |
| tree | 34abb1dd43dd1e64bdc63f3a6146847e0a38f0ba /docs | |
| parent | d11a366e70cc8ee4c1a5476cdee68643d577b601 (diff) | |
| download | YAGE-05685988739382343031b1fb2c94b74699f4ff7e.tar.gz YAGE-05685988739382343031b1fb2c94b74699f4ff7e.zip | |
Improving documentation further.
Made base README the main page.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Doxyfile | 10 | ||||
| -rw-r--r-- | docs/mainpage.dox | 7 |
2 files changed, 6 insertions, 11 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index 2afa6331..29c50bdd 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -790,7 +790,10 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = +INPUT = docs \ + src \ + include \ + README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -873,7 +876,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = docs/README.md # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -889,8 +892,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = */googletest/* \ - */build/* +EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the diff --git a/docs/mainpage.dox b/docs/mainpage.dox deleted file mode 100644 index 8a834554..00000000 --- a/docs/mainpage.dox +++ /dev/null @@ -1,7 +0,0 @@ -/** @mainpage - * - * YAGE - * ==== - * - * This is the main page of YAGE, the game engine. - */ |