Re: documentation generation question
| From: | Tony Bibbs | Date: | Fri, 04 Apr 2003 22:24:01 +0000 |
| Subject: | Re: documentation generation question | ||
| References: | 1 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-4654@lists.php.net to get a copy of this message | ||
Demian,
I think your note implies the notion that I didn't read the documentation.
Being the author of widely used open source PHP software I can appreciate
the perspective as I'm amazed at how many people do not RTFM.
That said, I have used the -o option before I contacted you. I also went
into the errors.html file and do not have any errors. So I'm still where I
started. I realize this is a beta, but it appears others have gotten the
@access, @author, @copyright, etc and all the descriptors to show up in
the resulting documentation. If I have no corresponding errors in
errors.html, how should I troubleshoot?
Also, I don't use windows but I'm assuming what you were talking about
works in linux under Apache. If so is this code different than what is
used by the command line? Personally I don't plan on using a web
interface for phpDocumentor but if the code bases are different then I'd
consider using it simply to get the valid output I'm expecting (which I
may do anyway).
Further input from you or Josh would be greatly appreciated.
--Tony
On Thu, 3
Apr 2003, Greg Beaver wrote:
> Hi Demian,
>
> You should read the tutorial at:
>
>
> http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html
>
> This will answer many questions.
>
> First off, both you and Tony would benefit from using the command-line
> option -o. You would benefit even more from using the web interface
> new_phpdoc.org. Simply place phpDocumentor in the web document root of
> a local webserver (NOT a publicly accessible webserver!) on your windows
> box, and browse to new_phpdoc.org, it will show you all of the options
> available and explain them for you.
>
> There are many, many templates, you can see sample output at
> http://www.phpdoc.org/docs
>
> Hope this is helpful, please direct any questions over the next week to
> Josh Eichorn, jeichorn@phpdoc.org, I am out of town.
>
> Greg
> --
> phpDocumentor
> http://www.phpdoc.org
>
> Demian Turner wrote:
> > Greg/Joshua,
> >
> > wow - talk about upgrading from PHPDoc :-) Fantastic package,
> > congratulations on what looks like a mountain of work.
> >
> > Install went smooth as silk, took about 2 seconds to get up and running
> > on Windows.
> >
> > Couple of questions while I have your attention:
> >
> > - had the same problem as Tony, with empty output for
> > Author/version/copyright - bug?
> > - is there a simmple way to disable listing of Files for any given package?
> > - any alternative stylesheets kicking around? Being able to widen the
> > left contents div would be handy
> >
> > Other than that great work,
> >
> > cheers,
> >
> > Demian
> >
> > Greg Beaver wrote:
> >
> >> Hi Demian,
> >>
> >> Um, install phpDocumentor :)
> >>
> >> Seriously, the time it takes to install will be justified by the time
> >> saved trying to work around the oddities of phpdoc.de's PHPDoc.
> >> Installation involves unzipping the archive into any directory, and
> >> running ./phpdoc. It's not really complicated. Of course, you could
> >> also sync from anonymous cvs, as it is MUCH more stable and
> >> feature-full than the 1.2.0beta3 release (we'll be doing a 1.2.0rc1
> >> release in about 2 weeks, when I have time to finish the docs and wrap
> >> up a few other loose ends)
> >>
> >> Once you're installed, use @package tags in the inherited classes to
> >> specify a different package.
> >>
> >>
> >> http://www.phpdoc.org/docs/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.package.pkg.html
> >>
> >>
> >>
> >> Greg
> >> --
> >> phpDocumentor
> >> http://www.phpdoc.org
> >>
> >> Demian Turner wrote:
> >>
> >>> Hi, I have a general question about document generation in PHP.
> >>> Currently I'm using PHPdoc from
> >>> http://www.phpdoc.de and am trying to
> >>> sort my docs into packages to follow the class structure.
> >>>
> >>> I know I should be using PHPdocumentor, haven't had time to install
> >>> it yet ;-) But following the logic PHPdoc uses, any class that
> >>> inherits from a class belonging to package A becomes part of package A.
> >>>
> >>> This can't be right, and as I'm using a java-style Object base class,
> >>> I cannot 'force' anything into separate packages.
> >>>
> >>> Anyone come up with a solution to this problem?
> >>>
> >>> cheers,
> >>>
> >>> Demian
> >>>
> >>
> >
>
>
--
Tony Bibbs "I guess you have to remember that those who don't
tony@tonybibbs.com hunt or fish often see those of us who do as
harmlessly strange and sort of amusing. When you
think about it, that might be a fair assessment."
--Unknown