Document more mods

ROADMAP

@@ -261,10 +261,14 @@ mods/pathogen/gravititus/init.lua:36: attempt to index local 'digger' (a nil val
   Maybe used with https://github.com/octacian/spawnpoint
 **** TODO May generate documentation for mods code
      :LOGBOOK:
+     CLOCK: [2020-05-27 mer. 18:38]--[2020-05-27 mer. 19:00] =>  0:22
      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:
+
+     *factions_ui/init.lua* is an example for documentation
+
 - [X] =luadoc -d doc/ mods=
   Bad layout and doesn't show 
   see https://keplerproject.github.io/luadoc/
@@ -275,9 +279,12 @@ mods/pathogen/gravititus/init.lua:36: attempt to index local 'digger' (a nil val
 - [-] 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
+    Trying to document factions_ui/init.lua to see if undocumented members
     are in logfile
 
+- [ ] mods/element_portals/liquid_portals/constants.lua is empty : 
+  can safely remove it ?
+
 - [ ] Retrying luadoc
   mods/factions/factions.lua has some correctly documented functions
   - [ ] We should be able to change style (#navigation not so large)

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 ???,???
-- (7) Tested pathogen modpack
+- (8) Document more mods
+- Tested pathogen modpack
 - Add documentation main page
 - Try to handle doxygen documentation
 - Check and test for lava bucket

mods/factions_ui/init.lua

@@ -21,7 +21,11 @@ function fac_player_count(faction)
 end
 
 
--- Return the formspec for the given faction index (or 0 if none)
+--- Return the formspec for the given faction index (or 0 if none)
+--
+-- @param faction_id The faction identifier
+--
+-- @return A formspec
 get_factions_ui = function(faction_id)
    local list = factions.get_faction_list()
    local t = { }
@@ -64,7 +68,12 @@ get_factions_ui = function(faction_id)
    return formspec
 end
 
--- Creates the new faction
+--- Creates the new faction from the factions_UI formspec
+--
+-- @param name   The faction name.
+-- @param player The new faction's leader.
+--
+-- @return true if the faction is created, false if an error occured.
 create_faction_from_UI = function(name, player)
    if faction then
       send_error(player, "You are already in a faction.")