Not signed in (Sign In)
 
Aug 26th 2007 edited
 
Some users have requested a complete documentation of the api in the last few month. Some even started writing it in the wiki documentation (3 classes are documented).

Like MySchizoBuddy suggested it, it would be far easier to use phpDocumentation and more useful - most IDE parse the in line doc for their syntax highlighter.

Do you have any experience with phpDocumentation? Who would like to document the code? And mark, are you ok with adding more documentation in the code?
 
Aug 27th 2007 edited
 
I'm a little reluctant to go for this, as it can encourage "undocumentation".

On the other hand, it might be better than what is there now.

But then there is another problem of when you update the code documentation, you will have to merge it with the wiki documentation, which might have been changed independently by some other person...
 
Aug 27th 2007
 
This is a terrifying prospect - especially when I'm starting to think about a whole new codebase for Vanilla 2. You guys are welcome to do it if you think it is really important, but I don't think I'll take any extra time for it myself.
 
Aug 29th 2007
 
I will add the required phpDoc tag to the library files and document some classes and function. That will be like a test for Vanilla 2.
 
Oct 30th 2007
 
MySchizoBuddy just sent a documentation version of the sql builder class.
http://lussumo.com/community/discussion/7270/sqlbuilder-documentation-on-wiki/

Added, Framework r140.

Issue information

  • 5
  • No assigned user

    No assigned user

     

  • Resolved
  • Low
  • Feature

Vanilla 1.1.5 is a product of Lussumo. More Information: Documentation, Community Support.