[Gambas-devel] Re: [Gambas-user] gambas 0.72

[Benoit Minisini]

Le Jeudi 20 Novembre 2003 16:21, Rob a écrit :
>
> If you can think of any more changes that you'd like, tell me now
> so I can include them the next time I have a block of time to do
> the wiki (probably next week when I go away for the holiday...)
>
> Rob
>

You can add the following to my previous mail about the Wiki documentation: 
:-)

* Ensure that the name of the documentation pages are logical, and give me 
this logic so that I can let the IDE component explorer index and find these 
pages easily.

* By browsing the *.component files, you can easily add the name of the 
authors in the component page.

* Static symbols could simply be displayed in bold. I think it is as readable 
as having a picture symbol.

* More important, classes having _get and/or _set methods must have a text 
that explains they can be used with the [] operator, like in the old 
documentation.

EX: 
http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponentQtListBox

You can do: PRINT hListBox[Index].Text

Best regards,

-- 
Benoit Minisini
mailto:gambas at ...1...


----------  Previous mail  ----------

Subject: Re: [Gambas-user] gambas documentation again
Date: Mercredi 5 Novembre 2003 19:47
From: Benoit Minisini <gambas at ...20...>
To: gambas-user at lists.sourceforge.net

Le Mercredi 5 Novembre 2003 08:00, Rob a écrit :
> OK, I spent some time tonight polishing up the new documentation
> extract, and from where I sit it's looking pretty good.  Please
> bash away at it and find any problems I have left.
>
> http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponent
>
> Rob

Hi, Rob,

Good job ! But you guess I have many remarks :-)

Here they are. I put a link so that you have an example of what I find wrong.

* You forgotten the point in the name of virtual class.
* You must make a difference between Object and Object[], otherwise one of
 the two is not displayed. Same thing for each array class.

EX: http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponentGb

* You should remove "(class)" from the title of class pages.
* The "Symbol" title is not necessary. I think the table is clear enough.
* The pages named "*Export" must not be displayed in the ReferenceBy. I
 didn't find a way to do that !

EX:
http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponentGbApplic
ation

* You must ensure that you don't add HTML stuff that can't display on the
TextView of QT. Browse the help in the IDE to see what I mean: text lines
beginning with 'pre' are displayed. Note this could be a bug of the
TextViewer.

EX: No link.

* It will be cool if you could list children class. For example, in .Array,
displaying Date[], String[], Object[], ...

EX:
http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponentGbArray

* If there is no event, or no property, or no method, it is not necessary to
display a void column in the symbol tables.

EX: http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponentGbGb

* You forgotten the definition in constant pages.

EX:
http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponentGbGbCons
tantBinary

* You forgotten the definition in event pages.

EX:
http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponentQtContro
lEventMouseDown

* There is a bad interaction between a property that return a virtual object
whose class has the same name than the property. Click on the "Menus"
property in the "Window" page to see what I mean. Maybe you should name the
page "GambasComponentQtWindowPropertyMenus" and keep
"GambasComponentQtWindowMenus" for the class.

EX:
http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponentQtWindow

That's all at the moment :-)

Regards,

-- 
Benoit Minisini
mailto:gambas at ...1...

-------------------------------------------------------