Re: Some Queries...
| From: | Christian Weiske | Date: | Thu, 17 Nov 2005 06:25:55 +0000 |
| Subject: | Re: Some Queries... | ||
| References: | 1 | Groups: | php.gtk.doc |
| Request: | Send a blank email to php-gtk-doc+get-1646@lists.php.net to get a copy of this message | ||
Anant,
> I see that you have decided not to include the xml files I sent earlier in
> the updated CVS version. The tarball is located at:
> http://www.kix.in/php-gtk-doc.tar
Please remember that we all have other things to to (e.g. life) and
can't always respond immediately.
> 1. How do I link to the parameters of any constructor or method? eg)
> GtkShadowType for the constructor of class GtkArrow
<paramdef><enumname>GtkShadowType</enumname>
<parameter>varname</parameter></paramdef>
You also can use <classname> and such tags.
> 2. What should I do when I encounter deprecated classes, constructors,
> methods and properties? Should I just delete their entries, or document them
> and put a note that they are deprectaed? eg) A lot of methods of the
> GtkEntry class.
First, write a big "DEPRECATED" at the beginning of the description and
short description.
> 3. The classes that I have included in the tarball were updated mostly by
> using information from the documentation of Gtk+-2.4 and the earlier
> PHP-GTK. Is that a problem? Do you require me to me original in my approach?
No. Copying things is fine as long the information is correct. So please
make sure you tested all the things you write. There is a directory
"examples/test" where we have test scripts we used to discover the
functionality. When you're doccing and writing such test scripts, add
these scripts as well.
--
Regards/MfG,
Christian Weiske
Attachment: [application/pgp-signature] OpenPGP digital signature signature.asc
Attachment: [application/pgp-signature] OpenPGP digital signature signature.asc