This page has moved


This page can now be found on the Wikka Documentation Server.
Thanks for updating your bookmarks!

An archive of old revisions of this page is still available for reference.

 


CategoryMigratedDocs
Comments [Hide comments]
2004-12-17 12:37:16
I have started on more coherent and complete documentation of the Wakka Core...
based on the current version. Does anyone want me to put it up on this page when done or should I do a new one ?
2004-12-17 13:10:42
Wherever it will be, that will be a very good contribution to this wiki fork. This would be a very valuable asset.
Comment by NilsLindenberg
2004-12-17 13:53:19
Don't care about the text here if you made a better one, George. Just replace it. I just started this, because no one else did :-)
Comment by JavaWoman
2004-12-17 15:20:21
Please remember that eventually (once the code is properly documented) we'll be able to *generate* completely cross-referenced documentation with phpDocumentor.

Don't write too much "outside" the code that should be part of the code to make it self-documenting.
Comment by DarTar
2004-12-17 15:45:57
I think it's a *very good* idea to add here a provisional documentation on Wikka core. We can always use later this documentation as a basis for inserting phpDoc compliant documentation in the code.
JW: I don't think it's a good strategy to discourage writing documentation at all, while we are waiting for the messianic arrival of phpDoc :)
Comment by JavaWoman
2004-12-17 16:28:50
I don't want to discourage writing documentation, but merely doing double work.

That said, some of the documentation on this page can be *used* (copied) for creating the documentation in the code (where it's needed more than on a page on the Wikka site: this is developer documentation after all, not end-user documentation).

But these descriptions (targeting developers, not end users) really belong in the code - so why not put them there?
I'm afraid the answer is: because no one has access to the actual code base via CVS to *add* the needed documentation.
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki