Re: [PHP] Help in PHPDoc
>From PhpdocSetupHandler.php
*
* By default only files with the suffix ".php" are recognized as
* php source code files and parsed. If you used other
* suffixes such as ".inc" you have to tell phpdoc to parse
* them.
$doc->setSourceFileSuffix( array ("php", "inc") ); in index.php
Regards,
Andrey Hristov
- Original Message -
From: "S.Murali Krishna" <[EMAIL PROTECTED]>
To: "Andrey Hristov" <[EMAIL PROTECTED]>
Cc: "S.Murali Krishna" <[EMAIL PROTECTED]>; <[EMAIL PROTECTED]>
Sent: Wednesday, March 13, 2002 7:41 AM
Subject: Re: [PHP] Help in PHPDoc
>
> Hi Andrey
> Thanks for your kind response first. I did the way you told
> but still after executing index.php, there is nothing in my doc directory
> just see the following snap of my code. I want to create documentation for
>
> ./xPage/xPagedoc.inc file and want the documentation to be in ./xPagedoc/
> directory. I think the following code is right for this.
>
> $doc->setApplication("xPage Repository");
>
> // directory where your source files reside:
> $doc->setSourceDirectory("./xPage");
>
> // save the generated docs here:
> $doc->setTarget("./xPagedoc");
>
> even I tried with absolute pathname for the above.
>
>
> Thanks
>
>
> On Tue, 12 Mar 2002, Andrey Hristov wrote:
>
> > I used it few times. You have to make modifications to index.php, so the engine
>will know where to look to for .php scripts that
> > have to be documented.
> > I've attached my index.php
> >
> > - Original Message -
> > From: "S.Murali Krishna" <[EMAIL PROTECTED]>
> > To: <[EMAIL PROTECTED]>
> > Sent: Tuesday, March 12, 2002 4:35 PM
> > Subject: [PHP] Help in PHPDoc
> >
> >
> > >
> > > Is anybody using PHPDoc for creating documentation, if yes could
> > > you tell me how to create documentation for a single "php" file which
> > > has enough comments needed by PHPDoc.
> > >
> > >
> > > <[EMAIL PROTECTED]>
> > > ---
> > > We must use time wisely and forever realize that the time is
> > > always ripe to do right."
> > >
> > > -- Nelson Mandela
> > > ---
> > >
> > >
> > > --
> > > PHP General Mailing List (http://www.php.net/)
> > > To unsubscribe, visit: http://www.php.net/unsub.php
> > >
> > >
> >
> >
>
> <[EMAIL PROTECTED]>
> ---
> We must use time wisely and forever realize that the time is
> always ripe to do right."
>
> -- Nelson Mandela
> ---
>
>
--
PHP General Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Help in PHPDoc
Hi Andrey
Thanks for your kind response first. I did the way you told
but still after executing index.php, there is nothing in my doc directory
just see the following snap of my code. I want to create documentation for
./xPage/xPagedoc.inc file and want the documentation to be in ./xPagedoc/
directory. I think the following code is right for this.
$doc->setApplication("xPage Repository");
// directory where your source files reside:
$doc->setSourceDirectory("./xPage");
// save the generated docs here:
$doc->setTarget("./xPagedoc");
even I tried with absolute pathname for the above.
Thanks
On Tue, 12 Mar 2002, Andrey Hristov wrote:
> I used it few times. You have to make modifications to index.php, so the engine will
>know where to look to for .php scripts that
> have to be documented.
> I've attached my index.php
>
> - Original Message -
> From: "S.Murali Krishna" <[EMAIL PROTECTED]>
> To: <[EMAIL PROTECTED]>
> Sent: Tuesday, March 12, 2002 4:35 PM
> Subject: [PHP] Help in PHPDoc
>
>
> >
> > Is anybody using PHPDoc for creating documentation, if yes could
> > you tell me how to create documentation for a single "php" file which
> > has enough comments needed by PHPDoc.
> >
> >
> > <[EMAIL PROTECTED]>
> > ---
> > We must use time wisely and forever realize that the time is
> > always ripe to do right."
> >
> > -- Nelson Mandela
> > ---
> >
> >
> > --
> > PHP General Mailing List (http://www.php.net/)
> > To unsubscribe, visit: http://www.php.net/unsub.php
> >
> >
>
>
<[EMAIL PROTECTED]>
---
We must use time wisely and forever realize that the time is
always ripe to do right."
-- Nelson Mandela
---
--
PHP General Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Help in PHPDoc
I used it few times. You have to make modifications to index.php, so the engine will know where to look to for .php scripts that have to be documented. I've attached my index.php - Original Message - From: "S.Murali Krishna" <[EMAIL PROTECTED]> To: <[EMAIL PROTECTED]> Sent: Tuesday, March 12, 2002 4:35 PM Subject: [PHP] Help in PHPDoc > > Is anybody using PHPDoc for creating documentation, if yes could > you tell me how to create documentation for a single "php" file which > has enough comments needed by PHPDoc. > > > <[EMAIL PROTECTED]> > --- > We must use time wisely and forever realize that the time is > always ripe to do right." > > -- Nelson Mandela > --- > > > -- > PHP General Mailing List (http://www.php.net/) > To unsubscribe, visit: http://www.php.net/unsub.php > > -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Help in PHPDoc
Is anybody using PHPDoc for creating documentation, if yes could you tell me how to create documentation for a single "php" file which has enough comments needed by PHPDoc. <[EMAIL PROTECTED]> --- We must use time wisely and forever realize that the time is always ripe to do right." -- Nelson Mandela --- -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
