diff --git a/Doxyfile b/Doxyfile index 3e7d7cf..1eeddc1 100644 --- a/Doxyfile +++ b/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "My Project" +PROJECT_NAME = "minetest-pvp" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -939,7 +939,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = mods/Mainpage.md #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -952,13 +952,13 @@ USE_MDFILE_AS_MAINPAGE = # also VERBATIM_HEADERS is set to NO. # The default value is: NO. -SOURCE_BROWSER = NO +SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. -INLINE_SOURCES = NO +INLINE_SOURCES = YES # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and diff --git a/ROADMAP b/ROADMAP index bac7a58..ca5547b 100644 --- a/ROADMAP +++ b/ROADMAP @@ -267,6 +267,8 @@ It's really fast. May be used on a website, to show the actual map. - [X] Testing, should fix =Can't locate Doxygen/Lua.pm = - [ ] Update doxygen documentation + - [ ] There's no Related page for factions_ui + - [ ] In fact, sources aren't documented, only README.md are collected **** DONE [feature_FactionUI] Try to add a factions UI :LOGBOOK: diff --git a/TODO b/TODO index 0b00e8b..8d26ee4 100644 --- a/TODO +++ b/TODO @@ -11,7 +11,8 @@ minetest-solebull - LGPL-2.1 - A PVP/faction game for minetest based on Cobalt. * v0.0.2-8 (10 Mar. 2020 - ???) CLOC ???,??? -- (5) Try to handle doxygen documentation +- (6) Add documentation main page +- Try to handle doxygen documentation - Check and test for lava bucket - Merge factions_UI branch with master - Add factions_UI to news.txt diff --git a/mods/Mainpage.md b/mods/Mainpage.md new file mode 100644 index 0000000..daa57a0 --- /dev/null +++ b/mods/Mainpage.md @@ -0,0 +1,3 @@ +# minetest-pvp + +A PVP-oriented modset for minetest. diff --git a/mods/factions_ui/README.md b/mods/factions_ui/README.md new file mode 100644 index 0000000..145af3e --- /dev/null +++ b/mods/factions_ui/README.md @@ -0,0 +1,3 @@ +# Factions UI + +A simple factions handling UI for the *factions* mod.