]> git.seodisparate.com - EntityComponentMetaSystem/commitdiff
Update Doxygen and README.md
authorStephen Seo <seo.disparate@gmail.com>
Wed, 8 Sep 2021 09:06:24 +0000 (18:06 +0900)
committerStephen Seo <seo.disparate@gmail.com>
Wed, 8 Sep 2021 09:06:24 +0000 (18:06 +0900)
Doxyfile
README.md
doxygen/mainpage.dox [new file with mode: 0644]

index 12b13074273b8bceea1bb14ebe9bdd37600cca98..efbdb5954ac2136e5129b7785bde95e8b44ce824 100644 (file)
--- a/Doxyfile
+++ b/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.
index 08f9fbeb75befb34d3ad3b5a8ac86634bca381be..9d8fe1385f83e8a31c0f6ff96785a0b624cb13fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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.  
diff --git a/doxygen/mainpage.dox b/doxygen/mainpage.dox
new file mode 100644 (file)
index 0000000..45979f4
--- /dev/null
@@ -0,0 +1,7 @@
+/*!
+    \mainpage EntityComponentMetaSystem Index Page
+
+    \ref md_README
+
+    <a href="annotated.html">Classes</a>
+ */