From: Carsten K. <car...@ya...> - 2003-10-30 00:30:07
|
On Thursday, October 23, 2003, at 06:43 am, Sergio Trejo wrote: > I just ran PHPDocumentor on PHPWiki using some basic inputs to > PHPDocumentor. I tried output as HTML and PDF. Wow, the PDF is 600+ > pages! > > The packages of Procedural Elements (what I've read of them all so > far) seem documented and cohesive with their descriptions of their > Classes. I noticed when running a basic (HTML:Smarty / default.ini) > PHPDocumentor process on the PHPWiki folder (runs recursively), that > the main package apparently requires a name (because it thinks that a > command-line PHPDocumentor switch "-o" is the name of the main package > which of course isn't true). Does anyone have any suggestions on the > best way to maximize PHPDocumentor to create as much documentation > about PHPWiki? Besides the packages and their classes, I didn't see > any output documentation that describes how PHPWiki is all tied > together using its many classes. Is there such an overview document, > or are PHPWiki users and developers on their own with respect to > understanding how all the pieces fit together? Anyone else used > PHPDocumentor on PHPWiki before? I scanned the Help and Open > Discussion forums and didn't find any previous discussion on this > topic. > > ST Hi, I have some understanding about the PHP objects in the code... BTW we have Jeff Dairiki to thank for upgrading PhpWiki to use object-oriented code. :) If he's not able to answer on the list at the moment due to RLO (real-life obligations), I'll see what I can answer. At the moment, if something is not commented within the source code itself or written in the documents available in CVS or at http://phpwiki.sf.net/phpwiki then it simply hasn't been documented yet. :/ Carsten |