Re: Some Queries...

From: Date: Sat, 19 Nov 2005 09:50:59 +0000
Subject: Re: Some Queries...
References: 1  Groups: php.gtk.doc 
Request: Send a blank email to php-gtk-doc+get-1651@lists.php.net to get a copy of this message
Hello Anant, > Please do send me suggestions on how I can improve and what is wrong with > the xml files that I sent. I am really eager to do this job, if you give me > the chance. The gtkentry example spits out a warning: PHP Notice: Use of undefined constant GTK_WIN_POS_CENTER - assumed 'GTK_WIN_POS_CENTER' in /data/cvs/phpgtk2/aaphp-gtk-doc/php-gtk-doc/examples/reference/gtk/gtkentry/constructor.phpw on line 20 please make sure your code is totally correct. Change the error logging settings in php.ini to E_ALL | E_NOTICE to get such warnings. You also wrote > gtk::main(); instead of the > Gtk::main(); we decided to use as conding standards. The doccing tutorial has a link to the coding standards file. Very nice that you commented every two or three lines - the beginners need this. - If you refer to some php values, e.g. NULL, you should put a <literal> tag around it: <literal>NULL</literal>. - Make sure you use the right case in your sentences: "The child widget" instead of "The Child Widget". - If you write short descriptions, please write long ones as well. - Be consistent with your dots at sentence ends. - Verify the class and enum names: You refer to GtkCalendarDisplayOptions while there is no such enum - it's only GtkCalendar. In that case, it's a bug in the enums. - If you provide an external example file, please link it in the code via xinclude and don't copy the code over to the xml - that makes it easier to change the code. - When linking functions, don't include the braces () in the text - they are appended automatically. I'm currently compiling the manual to test the changes and will commit them afterwards. Give me half an hour. -- Regards/MfG, Christian Weiske

Attachment: [application/pgp-signature] OpenPGP digital signature signature.asc
« previous php.gtk.doc (#1651) next »