Try to handle doxygen documentation

master
Solebull 2020-04-17 21:02:06 +02:00
parent 01dfbcba26
commit 576aba8b27
5 changed files with 2490 additions and 2 deletions

7
.gitignore vendored
View File

@ -9,4 +9,9 @@ tags
*.patch
## Removed mods
OLDmods/*/
OLDmods/*/
## Doxygen files/dirs
doxygen.log
html/
latex/

2451
Doxyfile Normal file

File diff suppressed because it is too large Load Diff

View File

@ -21,6 +21,24 @@ Allez dans le répertoire minetest/games/ puis :
git clone https://gitlab.com/solebull/minetest-pvp.git
### Documentation
J'essaye de documenter tant que possible le code des mods. La documentation
est génerée par `doxygen`. Mais avant tout, vous devrez installer
`https://github.com/alecchen/doxygen-lua` pour permettre a doxygen de
comprendre le code lua.
Suivant l'emplacement de `lua2dox`, vous devrez mettre a jour la variable
suivante de Doxyfile :
FILTER_PATTERNS = *.lua=/path/to/your/lua2dox
puis
doxygen
puis ouvrir html/index.html.
## En tant qu'administrateur
Après la géneration de la map, il faut y définir une *safe zone PVP* autout du

13
ROADMAP
View File

@ -255,6 +255,19 @@ It's really fast. May be used on a website, to show the actual map.
Or have a new ore named after him
- [ ] Make a new mod called spawn
Maybe used with https://github.com/octacian/spawnpoint
**** TODO May generate documentation for mods code
:LOGBOOK:
CLOCK: [2020-04-17 ven. 20:37]--[2020-04-17 ven. 21:00] => 0:23
:END:
- [X] =luadoc -d doc/ mods=
Bad layout and doesn't show
see https://keplerproject.github.io/luadoc/
- [X] see doxygen-lua (installed in ~/src/doxygen-lua)
https://github.com/alecchen/doxygen-lua/
- [X] Testing, should fix =Can't locate Doxygen/Lua.pm =
- [ ] Update doxygen documentation
**** DONE [feature_FactionUI] Try to add a factions UI
:LOGBOOK:
CLOCK: [2020-03-18 mer. 22:26]--[2020-03-18 mer. 22:41] => 0:15

3
TODO
View File

@ -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 ???,???
- (4) Check and test for lava bucket
- (5) Try to handle doxygen documentation
- Check and test for lava bucket
- Merge factions_UI branch with master
- Add factions_UI to news.txt
- Close formspec when faction is added