• Forum has been upgraded, all links, images, etc are as they were. Please see Official Announcements for more information

Want to generate doxygen on darkcoin source?

darkred

Active member
Doxygen is a tool that helps to document code. If you follow the doxygen conventions, you can generate documentation that shows how code is used. This is useful to people that are new to the code base. (like me)

It requires a few packages. For instance, on a mac, I needed to run:
brew install doxygen
brew install graphviz
Note: This assumes you have "brew" installed.

See http://www.stack.nl/~dimitri/doxygen/manual/install.html for more info on how to install the components.

After you have the prereq tools install, in the darkcoin root folder, run this:
doxygen doc/Doxyfile

Now there is a nice index.html file in /doc/doxygen/html. Open it up. Start learning. Start contributing. Keep buying DRK.
 
Incode documentation is a mess currently :)

If you read the code and have the ability to create/prepare doxygen documentation, feel free to contribute.
 
Back
Top