Jump to content






* * * * * 2 votes

PHPDoc Developer Documentation

Posted by bfarber, 15 January 2010 · 1,714 views

We'll keep this blog entry short and sweet, since there's not a whole lot to say.

Developers have asked for further documentation of IP.Board (and addon applications), specifically source code-level documentation of the various classes and methods that can be reused.  Those of you familiar with phpdoc will know that it's the perfect tool for the job, and thankfully we wrote IP.Board 3 using phpdoc-style comments to facilitate this job.

After a lot of cleanup and tweaking, we have made the phpdoc developer documentation available for all.  Please be aware that this is the first "release" of these documents, and there are likely going to be some oddities and under-documented functions.  Please let us know where we can expand on the documents.  We intend to add more code examples and to clean up the class-level documentation a little over time, but if you have any specific requests we'll focus on those first.

http://community.inv...docs/index.html




Nice!!!
Yay! :)
You just made my day :)
Thanks a lot :thumbsup:
i really like the last updated dates working in it ;).
Finally. :D nice work. :)
This is fantastic and will be a great reference! Thanks!

..Al
Do you think you could switch to Doxygen? Unlike phpDocumentor, it's actually still being updated and will already read the same code comments you've already made.

Do you think you could switch to Doxygen? Unlike phpDocumentor, it's actually still being updated and will already read the same code comments you've already made.


i've already spoke to bfarber about this and he is interested in it and promised to have a look @ it when he gets some free time. For the time being this is better than nothing. Doxygen also has search functionality which is good.
Thank You!
That's what I was waiting for! :) Thank you very much!
thanks, a downloadable zip would make it even better!
Thank you. This will save me us a lot of time. :)

Do you think you could switch to Doxygen? Unlike phpDocumentor, it's actually still being updated and will already read the same code comments you've already made.


It's something I will look into when I have some spare time available. I'd guess that might be a couple months away, but it's on my todo list somewhere.
I'm going to kill brandon if he does another mass commit in the svn :whistle: :whistle: :whistle: :P

Link is 404, where can you find these docs nowadays?