Update Doxygen and README.md
This commit is contained in:
parent
7b512958fd
commit
51bea5a40f
3 changed files with 13 additions and 2 deletions
4
Doxyfile
4
Doxyfile
|
@ -771,7 +771,7 @@ WARN_LOGFILE =
|
|||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = ./src/EC/Meta ./src/EC
|
||||
INPUT = ./src/EC/Meta ./src/EC ./doxygen/mainpage.dox ./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
|
||||
|
@ -796,7 +796,7 @@ INPUT_ENCODING = UTF-8
|
|||
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
|
||||
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
|
||||
|
||||
FILE_PATTERNS = *.hpp
|
||||
FILE_PATTERNS = *.hpp *.md
|
||||
|
||||
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
||||
# be searched for input files as well.
|
||||
|
|
|
@ -5,6 +5,10 @@ built and run using cmake (gtest is a dependency).
|
|||
|
||||
[(Note that gtest uses the BSD 3-Clause License.)](https://github.com/google/googletest/blob/master/LICENSE)
|
||||
|
||||
# Generated Doxygen Documentation
|
||||
|
||||
[Check this repository's gh-pages documentation on ECMS](https://stephen-seo.github.io/EntityComponentMetaSystem/)
|
||||
|
||||
# Compiling the UnitTests
|
||||
|
||||
Create a build directory.
|
||||
|
|
7
doxygen/mainpage.dox
Normal file
7
doxygen/mainpage.dox
Normal file
|
@ -0,0 +1,7 @@
|
|||
/*!
|
||||
\mainpage EntityComponentMetaSystem Index Page
|
||||
|
||||
\ref md_README
|
||||
|
||||
<a href="annotated.html">Classes</a>
|
||||
*/
|
Loading…
Reference in a new issue