RE: PHPDoc help - how to document include files?
| From: | Stowe, Nola | Date: | Fri, 30 Apr 2004 15:55:22 +0000 |
| Subject: | RE: PHPDoc help - how to document include files? | ||
| Groups: | php.pear.general | ||
| Request: | Send a blank email to pear-general+get-12261@lists.php.net to get a copy of this message | ||
Thanks!! ... it seems to insist that the first docblock have a package
specified, then it also insists that the docblock for the class has one. Is
this "ok" ?? I just want to make well formed documentation.
So this is what I have:
<?
/**
* Page Class
*
* A page to control a 'page'
*
* @package Intranet
* @version 0.1
* @author Nola
*/
/**
* Base class for Page Object
*/
include_once("/opt/php/lib/php/PEAR.php");
/**
* Page Class
* @package Intranet
*/
class Page extends PEAR {
------
I still get this error:
Warning - Class Page parent PEAR not found
anyway to make it generate docs for Pear.php too?
Also, on the command line I specifed two files, but its only doing the first
one..
here's my command line (directory names changed to protect the innocent)
phpdoc -f ~/.../Page.class.php,~/.../HomePage.class.php -t ~/.../test/doc
-ti "Intranet Documentation" -o "HTML:frames:default"
Thanks alot for any help! (I do try to search the net and read documentation
before asking)
> -----Original Message-----
> From: Greg Beaver [SMTP:cellog@php.net]
> Sent: Friday, April 30, 2004 10:27 AM
> To: Nola Stowe
> Cc: 'pear-general@lists.php.net'
> Subject: Re: PHPDoc help - how to document include files?
>
> Nola Stowe wrote:
>
> > How do I document include files?
> >
> > PHP:
> >
> > <?
> > /**
> > * Page Class
> > *
> > * A page to control a 'page'
> > *
> > * @package Intranet
> > * @version 0.1
> > * @author Nola
> > */
> /**
> * Base class for the Page object
> */
> > include_once("PEAR.php");
> >
> /**
> * Class page does blahblahblha...
> * @package Intranet
> */
> > class Page extends PEAR {
> > ...
> >
>
> Et voila.
>
> :)
> Greg
>
<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
The information in this email and any attachments may contain
confidential information that is intended solely for the
attention and use of the named addressee(s). This message or
any part thereof must not be disclosed, copied, distributed or
retained by any person without authorization from the addressee.
If you are not the intended addressee, please notify the sender
immediately, and delete this message.
<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>