RE: [PHP-DOC] MySQLI Documentation
| From: | Steph | Date: | Sun, 23 Nov 2003 01:08:17 +0000 |
| Subject: | RE: [PHP-DOC] MySQLI Documentation | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969357028@lists.php.net to get a copy of this message | ||
heh, welcome to the wonderful issues of php-gtk..
> -----Original Message-----
> From: Gabor Hojtsy [mailto:gabor@hojtsy.hu]
> Sent: 22 November 2003 17:29
> To: Georg Richter
> Cc: phpdoc@lists.php.net
> Subject: Re: [PHP-DOC] MySQLI Documentation
>
>
> >>The DOMXML extension has this kind of documentation.
> >
> > No, DOMXML only supports OO-Syntax, not OO and procedural style.
> > Also class->method is hard to read instead to have a list of
> properties and
> > methods for different objects.
>
> Well, the dir class has some true OO documentation, but there is not
> much real OO docs in the XML sources.
>
> The dir class uses classsynopsys:
> http://www.docbook.org/tdg/en/html/classsynopsis.html
>
> This enables you to provide an overwiev of the class, but does not let
> you add documentation for methods or attributes. I would suggest you
> document the mysqli class with this syntax on the intro page of the
> mysqli section, and then note on each function page that there is an OO
> syntax to use it.
>
> Unfortunately I have never used DocBook to document OO stuff, so I have
> no personal experience.
>
> Goba