Comment 2 for bug 893275

Revision history for this message
kaputtnik (franku) wrote :

The lua documentation has a big shortcoming: There is currently no possibility for searching and the related django-app isn't maintained anymore, a search wouldn't be implemented.

Since both, doxygen and sphinx can make full featured html files, why do we not serve just the produced html?

Or/and provide the documentations as zip files for download? Build them daily (or once a month) on the server and provide a download link. Some starter pages, which will likely not change that often, can be included in the wiki.

BTW: Building the doxygen generated html results in lot of warnings and undocumented parameters e.g.

src/economy/input_queue.h:175: warning: argument 'fr' of command @param is not found in the argument list of Widelands::InputQueue::read(FileRead &f, Game &g, MapObjectLoader &mol)

src/economy/economy.h:205: warning: unable to resolve reference to `Cmd_Call_Economy_Balance' for \ref command

I looked into one and it seems those warnings are just there because a change of a variable name was not reflected for the documentation part. Or are forgotten to remove during restructuring? Anyway the produced documentation is working. No idea if it is also valid :-D