Peter Hartman (To 1886) wrote:
Et al,
I'm interested in either designing or participating in a current project
which utilizes PHP and XML to create a documentation application.
My company (caravelcms.org) has designed a content management system using
PHP and we are currently investigating how we can document effectively our
various userland functions. Instead of re-inventing the
wheel, I thought I'd put a call out to the PHP community to see
if you could push me in the right direction. Basically, what I want
is a way
of writing and storing and inter-linking documentation for our application.
It seems XML would be the best route to go, but I'd
prefer the documentation app to also be in PHP. I'd imagine others
have had a similar desire and perhaps an app is out there already.
You can use DOCBOOK (XML) to source your documentation, and then use PHP
to generate the resulting XML files, or you can use any number of the
"javadoc"-like php auto-documentation generators.
The PEAR syntax guide has an example to effectively document
classes/methods so that phpdocumentor (and other auto-documentation
generators) can create the documentation automatically. There was a
similar question recently to which I (and others) posted some links to
some auto-document generators.
--
Burhan Khalid
phplist[at]meidomus[dot]com
http://www.meidomus.com
---
"Documentation is like sex: when it is good,
it is very, very good; and when it is bad,
it is better than nothing."
--
PHP General Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
