search

MattGuerrette / VixenEngine

Open Source C++ Game Engine
http://mattguerrette.github.io/VixenEngine/
GNU General Public License v3.0
39 stars 13 forks source link

[All] documentation comments need to be added for doxygen #3

Open MattGuerrette opened 9 years ago

MattGuerrette commented 9 years ago

Vixen needs to have its code documented. This way, we can generate doxygen documentation that can eventually be linked to on developer site.

GonzoBright commented 9 years ago

Shall I start the process of documenting? I haven't much experience with DoxyGen, but it shouldn't be too difficult.

MattGuerrette commented 9 years ago

If you would like to sure. I would first research the format for doxygen comments on their website.

GonzoBright commented 9 years ago

As a matter of fact I'm doing that right now. Are you planning to add contributors to the project, or shall the project be solely based on pull requests?

MattGuerrette commented 9 years ago

at the moment, it will be based on pull requests. Those that will be added as collaborators will be accounts that have made multiple pull requests and have contributed most to the project. That way I don't add a bunch of collaborators who aren't actually doing anything for the project.

GonzoBright commented 9 years ago

Perfect. That'll do.

I've noticed there's already a directory with all of the applicable doxygen files, did you perform a complete setup beyond the insturction to make the tool itself? In essence, I'm trying to get an idea as to where to start.

MattGuerrette commented 9 years ago

The existing files in the doxygen folder can be removed. That is an old version. They will most likely be written over anyway, if you output to that folder. But to be safe, delete all files in that directory and then run doxygen

MattGuerrette commented 9 years ago

Note: Doxygen should only be run on source and include files actually being built into the engine. So, all files in UNUSED folders should be added to the excluded list when running doxygen.