[Gambas-user] Questions about the documentation of a component

Hans Lehmann hans at gambas-buch.de
Wed Jan 9 18:45:04 CET 2019


Am 09.01.19 um 14:36 schrieb Benoît Minisini:
> But you can write your documentation inside the source code of your 
> component (if it is written in Gambas) as explained at 
> http://gambaswiki.org/wiki/doc/helpcomments.
> That inline help will be taken into account by the IDE. 
Hello.

The information in the documentation for help comments must be 
supplemented for events:

Event Finished '' The event is triggered when the TimeoutCountDown has 
expired
Event Tick '' The event is raised each time the CountDown counter is 
decremented. See property 'Delay'.

Result: The last help comment is NOT displayed in the documentation of 
the component.

'' The event is triggered when the TimeoutCountDown has expired
Event Finished
'' The event is raised each time the CountDown counter is decremented. 
See property 'Delay'.
Event Tick

Result: All help comments are displayed in the component documentation.

Yours sincerely

Hans


More information about the User mailing list