Doumention software?

aidancheddar

aidancheddar

Active Member
I've noticed Afr0 has started putting in more comment documentation (e.g. <summery>[insert what the codes here]</summary>) within the PD source code. This is excellent. The areas that were covered so far are very, very, important parts - in the long run. So, I'm wondering, what documentation software should we use so others developers (such as myself) can jump in without the blindfold? Doxygen, .NET documention generator, or...?

Note to 99% of the users here: this has a different purpose then wikis. Instead of "cookbook"-like user guide, these aim providing information to aid developers in producing software you guys play or test.
 
.NET documentation generator seems like the best format, but it won't make much sense to generate docs in the game's current state (most functions will still be unexplained! some things are public that do not need to be etc)
 
I've been using Doxygen to generate documentation to see what it would look like, what's missing etc.
I disagree with Rhys, I definitely think we should generate documentation - hence the recent work!
What's missing now is mostly the client itself, which I can do. As far as the Simantics VM, that's a massive amount of work and should ideally be done by Rhys, but I will document whatever I can based on context.
The main problem is that since the project is still under heavy development, the docs would most likely have to be updated for each version or be off - but I think even if they're off, that's a trafe off worth paying if we can attract more developers.
 
On another note, my C# learning is going to be off and on while I finish learning Blender too. Just throwing that out there.
 
aidancheddar said:
Both valid points. Though, Afr0, if you agree then, I'd love to see some documention on the code.
Click to expand...
I can't send it to you right now, I'm working on some important stuff. Some crazy woman told me she'd (re)publish my book (!!), so I've been working on revising that, and at the same time I need to revise my next book project that a Norwegian publisher said they wanted.
Between all of that, I'm working on PDChat when I have the time.
Just download Doxygen and run the wizard!
 
Afr0 said:
I can't send it to you right now, I'm working on some important stuff. Some crazy woman told me she'd (re)publish my book (!!), so I've been working on revising that, and at the same time I need to revise my next book project that a Norwegian publisher said they wanted.
Click to expand...
Congrats!
Afr0 said:
Just download Doxygen and run the wizard!
Click to expand...
I was unaware of a wizard. Thank you. XD
 
You must log in or register to reply here.
Back
Top