Re: new tag needed?
| From: | Greg Beaver | Date: | Tue, 14 Jan 2003 18:45:53 +0000 |
| Subject: | Re: new tag needed? | ||
| References: | 1 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-279@lists.php.net to get a copy of this message | ||
I am concerned about confusion between @package and @category, as many users
have found using @package confusing as it is. Perhaps there is a better way
to do the classification that we haven't thought of. As it stands, PEAR is
a unique system, and there already is a --pear command-line switch. Maybe
for the --pear switch, we can have phpDocumentor do something special for
the category.
By "do something special" I have a few vague ideas, and here are their
beginnings:
--search for a peardoc.packagename.ini file that contains particular
information and settings. This solution will be extensible if peardoc
changes in the future, and avoid cluttering code. It will also allow
changing of category without modification of source code (a good thing, I
think, since category is not really code-related at all)
--have one master peardoc.ini file with sections for each package like:
[package]
category = blah
This may be better for Alex, since as editor he will have control over
category (as it should be, I don't think this should be up to the
programmer, really). phpDocumentor could raise an error if more than one
peardoc.ini file is found. Again, extensibility will be easy.
--interface with pear.php.net and extract category automatically using some
kind of web thingy like SOAP or XML_RPC (pass in package, it passes out
category) This is probably the least likeable option until the entire world
is internet-enabled without using modems :)
Any thoughts?
Greg
"Limbourg Arnaud" <arnaud.limbourg@cegetel.fr> wrote in message
news:40043BDD1EC9D211946400A024A6E1840D1FBB35@cassandre.sfr.com...
> Hi,
>
> It would make sense indeed.
>
> @pearcategory looks reasonnable to me.
>
> Arnaud.
>
> > Hi,
> >
> > for the peardoc2 template, it is impossible for phpDocumentor
> > to guess the
> > category that documentation fits into, since the directory
> > structure does
> > not reflect this in the pear repository. This leads to the
> > question: should
> > I add a new tag @peardoccategory or something like that,
> > which is only used
> > by the peardoc2 converter and only needed by PEAR classes?
> >
> > Take care,
> > Greg
> > --
> > phpDocumentor
> > http://www.phpdoc.org
> >
> >
> >
> > --
> > PEAR Documentation List Mailing List (http://pear.php.net/)
> > To unsubscribe, visit: http://www.php.net/unsub.php
> >
>