[Gambas-user] An easy way to document a Gambas program?

Lord Quo lord.quo at ...626...
Tue Sep 14 20:02:50 CEST 2010


    Thanks! With this example is more clear to me.

    :-)

--------------------------------------------------
From: "Fabien Bodard" <gambas.fr at ...626...>
Sent: Tuesday, September 14, 2010 12:29 PM
To: "mailing list for gambas users" <gambas-user at lists.sourceforge.net>
Subject: Re: [Gambas-user] An easy way to document a Gambas program?

> normally it will work :/* (you can add a <br> at the line end)
> the text is formatable with a wiki style
> 
> AN EXEMPLE :
> 
> '' +Description
> '' Initialize a web browser view with the help on a specific symbol.
> '' +Arguments
> '' - #hWebView# is the WebView control to initialize.
> '' - #iType# is the type of the symbol.
> '' - #sSymbol# is the symbol.
> '' - #sClass# is the class if the symbol is a member of this class.
> '' - #sMore# is a suffix that will be added to the URL of the help page.
> '' - #hEditor# is the source code editor that the symbol comes from.
> '' +Symbol types
> '' The #iType# argument can be one of the following constants, defined
> in the MHelp module:
> '' - =TYPE_NATIVE= for a native datatype.
> '' - =TYPE_CLASS= for a class.
> '' - =TYPE_CONTROL= for a control name.
> '' - =TYPE_SYMBOL= for a class symbol, a local or a global variable.
> '' - =TYPE_EVENT= for an event.
> '' - =TYPE_KEYWORD= for a language keyword.
> '' - =TYPE_SPECIAL= for a special method.
> 
> Public Sub InitWebViewWith(hWebView As WebView, iType As Integer,
> sSymbol As String, Optional sClass As String, Optional sMore As
> String, Optional hEditor As FEditor)
> 
>  Dim cSymbol As Collection
>  Dim hSymbol As CSymbolInfo
>  Dim hClass As CClassInfo
>  Dim hComp As CComponent
 




More information about the User mailing list