Re: Re: Final push towards PHP 4 release
| From: | eschmid | Date: | Sun, 12 Mar 2000 21:02:23 +0000 |
| Subject: | Re: Re: Final push towards PHP 4 release | ||
| References: | 1 | Groups: | php.dev |
| Request: | Send a blank email to php-dev+get-16729@lists.php.net to get a copy of this message | ||
On Sun, 12 Mar 2000, Kristian Koehntopp wrote:
> eschmid wrote:
> > And please note that in PHP 4 are many new and old functions without
> > proper function prototypes as recommended in CODING_STANDARDS under
> > "Documentation and Folding Hooks".
>
> Regarding the topic of documentation: I have added a lot of
> comments to domxml.xml laying out some internal of the domxml
> classes. I did not commit any actual XML, because I do not know
> how we document classes with the current documentation system.
> If somebody shows me an example, I will finish domxml's
> documentation.
>
> I'd like to see something similar to PHPLIB class documentation
> for PHP4 classes, that is
>
> classname
> purpose
> public slots
> privately used slots (even if PHP4 does not have private members)
> public methods
> private methods (even if PHP4 does not have private methods)
> example usage
If you will document classes with DocBook you should have the newest
version of Normans XML DTD. I was reading Normans book this afternoon and
remembered that he writes, there is only a element ClassName and no
ClassMethod. If you need one, you have to change the DTD.
Unfortunately I couldn't find this page now, because this book isn't
indexed very well.
I follow the discussion on the oasis mailing list, but I'm not very strong
in OO.
I think Stig have the best overview about this topic. Remember there are
more undocumented OO features in PHP3 and PHP4, including Java, SAPI
servlets and JSP.
-Egon