PHPdoc?
| From: | Soeren Staun-Pedersen | Date: | Thu, 01 Jun 2000 21:32:37 +0000 |
| Subject: | PHPdoc? | ||
| Groups: | php.dev | ||
| Request: | Send a blank email to php-dev+get-20013@lists.php.net to get a copy of this message | ||
hey
When I first encountered the word "phpdoc" (set case as it pleases you),
I thought it was something similar to JavaDoc (the system for formatting
comments in the java source code files into nice hyperlinked html
documents... most people know this I guess). I was kinda disappointed to
find out that something like this already existed. I coded an entire such
system myself you see. :-)
Now the problem is, that my computer got stolen, which included a complete
CVS wrap (more active than webcvs) and the PhpDoc tool (all in php3/4) and
requiring no databases at all, which is why I ask this:
Would anyone think it would be a good idea to create a "real phpdoc tool"?
Perhaps it could work a bit like this:
//:CLASS myClass
//My class is a class designed by me, and
//I can describe it over several lines, and
//use <b>html</b> tags in the documentation.
class myClass extends myParentClass
{
....
//:FUNCTION my_own_function str int
//This function takes the str and runs my own
//function on it int times.
function my_own_function()
{
//Constructor (this line is skipped since it does not have the right
//start.
myParentClass::myParentClass();
...
}
And then turn this into a file called myClass.html which starts out by
putting the class description and then listing the funcitons with the
according documentation.
I wanna do this, anybody wanna help?
Soeren Staun-Pedersen - Staun@SunSITE.auc.dk
------
"The internet is full, beat it"
- Me.