Skip to content

Commit

Permalink
Clean up documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
morganbengtsson committed Jun 17, 2020
1 parent 9cbfd3c commit a0973c2
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
4 changes: 2 additions & 2 deletions doc/config.doxy
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.

INPUT = ../include ../README.md
INPUT = index.doc ../include

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Expand Down Expand Up @@ -779,7 +779,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE = README.md
USE_MDFILE_AS_MAINPAGE = NO

#---------------------------------------------------------------------------
# configuration options related to source browsing
Expand Down
7 changes: 7 additions & 0 deletions doc/index.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!

\mainpage

API documentation for the <a href = "https://github.com/morganbengtsson/mos">MOS game engine</a>.

*/
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

# General information about the project.
project = 'MOS'
copyright = '2015, Morgan Bengtsson'
copyright = '2020, Morgan Bengtsson'

version = '1.0.0'
# The full version, including alpha/beta/rc tags.
Expand Down

0 comments on commit a0973c2

Please sign in to comment.