Re: phpDocumentor with PEAR layout
| From: | Greg Beaver | Date: | Sun, 05 Jan 2003 06:04:30 +0000 |
| Subject: | Re: phpDocumentor with PEAR layout | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-12119@lists.php.net to get a copy of this message | ||
Hi Christian,
All of your suggestions are excellent, except I don't understand what you
mean by having the global doc name available on all pages, do you mean
the --title commandline? If so, that makes a lot of sense. Let's
brainstorm some more on other things PEAR would like to see, and compare
notes with what full applications need. It may make sense to separate the
pear-specific features into more than one option, so that other applications
can choose what they need, but PEAR would still benefit fully. Maybe a pear
switch could be used to turn on all of these options. There is already a
pear-aware element in the source location. If the template options.ini file
has a use_pear flag, it strips PEAR out of source_location to show what to
put in an include statement (instead of PEAR/DB/mysql.php it shows
DB/mysql.php).
It's all good. :)
Greg
--
phpDocumentor
http://www.phpdoc.org
"Christian Dickmann" <chrisdicki@gmx.de> wrote in message
news:20030104214341.78974.qmail@pb1.pair.com...
> > It looks pretty good. I think the icons should be changed, they draw
too
> > much attention against the mild greens, and perhaps drop them altogether
> in
> > the right-hand side.
>
> I wouldn't do that. I think attention is good, cause you directly know
> what kind of item you got. The Doc has so much info, so much text,
> you _need_ to know what kind of item you see.
>
> > Also a small suggestion, if you set defaultpackagename = PEAR in the
.ini
> > file you use to parse, it will get rid of default.
>
> Thanks for this info
>
> > We are very interested in your template for the next release, once the
> pear
> > community decides it looks good.
>
> Would be cool.
>
> I have a few suggestions/notes:
> - I would like to have the global doc name available on all pages.
> - phpDoc should try to guess the package name. With PEAR CS
> this should be possible for PEAR (maybe a PEAR switch would be
> a good idea). Example: phpDoc parses DB.php and notes its
> package (DB). Now phpDoc parses DB/mysql.php where no @package
> tag is specified. phpDoc notices, that DB/mysql.php belongs to package
> DB cause its in DB dir relative to DB.php ...
> - phpDoc should add a Notice to errors.html that @package is missing
> - if the mentioned PEAR switch is on, you could check if a method/var
> is prefixed by "_" and add a notice that it should be marked with @access
> private (or just do it implicit). Destructors could be detected the same
> way.
> - Info like the value of constants should be run through htmlentities()
> (see
>
http://dickmann.homeunix.org/pear/phpdoc/PEAR/Math_Bigint/_Math_Bigint_Bigin
> t_php.html)
> "2 << xyz" is not printed correctly and produces incorrect HTML
>
> Christian Dickmann
>
>