diff --git a/.gitignore b/.gitignore index 0371e06..5f77adf 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,4 @@ OLDmods/*/ doxygen.log html/ latex/ +doc/ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0061b48 --- /dev/null +++ b/Makefile @@ -0,0 +1,4 @@ +.PHONY: doc + +doc: + luadoc -d doc/ mods diff --git a/ROADMAP b/ROADMAP index ca5547b..436452f 100644 --- a/ROADMAP +++ b/ROADMAP @@ -257,6 +257,8 @@ It's really fast. May be used on a website, to show the actual map. Maybe used with https://github.com/octacian/spawnpoint **** TODO May generate documentation for mods code :LOGBOOK: + CLOCK: [2020-05-07 jeu. 21:54]--[2020-05-07 jeu. 22:17] => 0:23 + CLOCK: [2020-05-07 jeu. 16:37]--[2020-05-07 jeu. 16:47] => 0:10 CLOCK: [2020-04-17 ven. 20:37]--[2020-04-17 ven. 21:00] => 0:23 :END: - [X] =luadoc -d doc/ mods= @@ -266,9 +268,16 @@ It's really fast. May be used on a website, to show the actual map. https://github.com/alecchen/doxygen-lua/ - [X] Testing, should fix =Can't locate Doxygen/Lua.pm = -- [ ] Update doxygen documentation - - [ ] There's no Related page for factions_ui +- [-] Update doxygen documentation + - [X] There's no Related page for factions_ui - [ ] In fact, sources aren't documented, only README.md are collected + Trying to docuent factions_ui/init.lua to see if undocumented members + are in logfile + +- [ ] Retrying luadoc + mods/factions/factions.lua has some correctly documented functions + - [ ] We should be able to change style (#navigation not so large) + We could replace doc/luadoc.css directly **** DONE [feature_FactionUI] Try to add a factions UI :LOGBOOK: diff --git a/mods/factions_ui/init.lua b/mods/factions_ui/init.lua index 52436eb..a624798 100644 --- a/mods/factions_ui/init.lua +++ b/mods/factions_ui/init.lua @@ -1,13 +1,17 @@ +--- Keep the module path local modpath = minetest.get_modpath("factions_ui") +--- Send the given message to the given player +-- @param player The player to send the message to +-- @param message The message to be sent local send_error = function(player, message) minetest.chat_send_player(player, message) end --- Count and return the number of players in the given faction +--- Count and return the number of players in the given faction -- --- \param faction A faction object +-- @param faction A faction object function fac_player_count(faction) local count = 0. for k, v in pairs(faction.players) do