[Gambas-user] Documentation inside source code & wiki
Benoît Minisini
g4mba5 at gmail.com
Sat Mar 13 19:34:58 CET 2021
Hi,
I fixed some bugs in the wiki, and finally the documentation written in
the comments of the components source code is now automatically inserted
into the wiki without having to edit it.
For one documentation page, you can now either:
- Not creating it. In that case, a page is automatically generated from
the help comments in the source code.
- Creating a page, using the '@{help}' wiki command to insert into your
specific page the help coming from the source code comments, and adding
some specific stuff.
- Creating a page, and type what you want.
By the way, for example, the 'gb.test' is well documented, but I think
the help comments need a bit of love by using the wiki markdown syntax
for non proportional text, examples...
Regards,
--
Benoît Minisini
More information about the User
mailing list