[Gambas-user] Help comments are now exported

[Jussi Lahtinen]

Thanks, this is really useful!
I'll test it as soon I get some time.

Jussi



On Sat, Nov 10, 2012 at 2:26 AM, Benoît Minisini <
gambas at ...1...> wrote:

> Hi,
>
> Since revision #5311, help comments are now exported by the compiler
> into the information files of libraries and components (*.info files).
>
> Consequently, if you define some help in your libraries, you will see
> them in the IDE!
>
> Help comments must begin with two quotes and a space (`'' `), and must
> be located:
>
> - On the same line of the declaration of the documented symbol.
>
> - Or on several lines just before the declaration of the documented symbol.
>
> A class can have its own help comments. The class help comments must
> begin with three quotes and a space (`''' `), and must be the first help
> comments of the class source file.
>
> Note: The syntax used in help comments is a Gambas markup language
> mainly inspired from the Markdown markup language. [1]
>
> Enjoy it!
>
> [1] http://en.wikipedia.org/wiki/Markdown
>
> --
> Benoît Minisini
>
>
> ------------------------------------------------------------------------------
> Everyone hates slow websites. So do we.
> Make your web apps faster with AppDynamics
> Download AppDynamics Lite for free today:
> http://p.sf.net/sfu/appdyn_d2d_nov
> _______________________________________________
> Gambas-user mailing list
> Gambas-user at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/gambas-user
>