Jump to content

Invision Community Blog


Managing successful online communities

bfarber
 Share


PHPDoc Developer Documentation

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.invisionpower.com/resources/phpdocs/index.html

 Share

Comments

Recommended Comments

[quote name='Tim Dorr' date='16 January 2010 - 08:00 PM'] 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.

Link to comment
Share on other sites

[quote name='Tim Dorr' date='16 January 2010 - 03:00 PM']
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.

Link to comment
Share on other sites



Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Add a comment...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Loading...

Important Information

We use technologies, such as cookies, to customise content and advertising, to provide social media features and to analyse traffic to the site. We also share information about your use of our site with our trusted social media, advertising and analytics partners. See more about cookies and our Privacy Policy

×