+- Cuberite Forum (https://forum.cuberite.org)
+-- Forum: Cuberite (https://forum.cuberite.org/forum-4.html)
+--- Forum: Development (https://forum.cuberite.org/forum-13.html)
+--- Thread: Doxygen (/thread-540.html)
Pages:
1
2
Doxygen - xoft - 08-22-2012
For those who haven't noticed, I have managed to cobble together a doxygen config file that generates the doxygen documentation from the MCServer sources. This is especially useful for viewing the class hierarchy or some base overview of the code.
It would be immensely helpful if all the devs could add comments to newly written code, at least to the major functions, documenting what the code does. I've been doing something like that for some time, should you need an example.
This is even more useful for functions that are virtual and there are descendants overriding those functions. Interface definitions are a must. If there's ever a need to make yet another descendant, it's vital that we know what each virtual function does exactly. See the cChunkGenerator.h file for an example.
I know that writing docs is boring and noone likes to do that, but it's the stuff that helps the most in the long run. Please try to do it at least a little bit.
RE: Doxygen - sphinxc0re - 02-16-2015
Warm up!!!
Wouldn't it be good if the DoxyGen manual generated automatically on @bearbin s buildserver?
RE: Doxygen - xoft - 02-16-2015
I tried setting automatic builds on my webhost: http://mc-server.xoft.cz/doxy/html/
I didn't manage to schedule it to run regularly, though.
RE: Doxygen - LogicParrot - 02-16-2015
This is awesome
RE: Doxygen - sphinxc0re - 02-16-2015
It's easy using the crontab. Does it run on a linux server?
RE: Doxygen - LogicParrot - 02-16-2015
I have a question: Doxygen is supposed to auto-generate the docs from source, but where is it grabbing the sentences from?
For instance, bool cWorld::AddChunkClient has this description:
Quote:Adds client to a chunk, if not already present; returns true if added, false if present
But this sentence does not exist in World.h or World.cpp. So, where was it fetched from?
RE: Doxygen - xoft - 02-16-2015
It does run on Linux, but I don't have root access to it - it's semi-managed. Also they seem to have some sort of CPU throttle, when I ran something too CPU-intensive for some time, the thing would just kick me and reboot.
RE: Doxygen - xoft - 02-16-2015
The doxy pages are about half a year old, the sources may have changed in the meantime.
RE: Doxygen - xoft - 02-16-2015
It's in the header: https://github.com/mc-server/MCServer/blob/master/src/World.h#L357-L358
RE: Doxygen - LogicParrot - 02-16-2015
(02-16-2015, 03:29 AM)xoft Wrote: It's in the header: https://github.com/mc-server/MCServer/blob/master/src/World.h#L357-L358
Oh, thanks. So this is outdated.