[prev in list] [next in list] [prev in thread] [next in thread] 

List:       gambas-devel
Subject:    [Gambas-devel] Extracting Gambas documentation from C/C++ sources
From:       Tobias Boege <tobias () gambas-buch ! de>
Date:       2013-05-01 15:24:43
Message-ID: 20130501152443.GC550 () aurora
[Download RAW message or body]

Hi,

with reference to [0] from Nov 2012, I sat down today and wrote a bunch of
scripts to get Benoit's idea to reality. The project is attached together
with a sample component to test it.

The suite of programs takes C/C++ source files, extracts documentation
comments and merges them into an ordinary .info file from gbi3.

Currently, I think, methods and properties are supported, i.e. everything
that has a corresponding BEGIN_* line in the C/C++ source code. This means
no constants for now but that can easily be added with a little hack, I
think.

I grep'd through trunk and came to the conclusion that /** can't be used as
a starter for the documentation and */ can't be the end because this pattern
is used sometimes for C/C++ function documentation.

I freely added a 'G' flag and another asterisk respectively, so that
documentation that shall go into the .info file must be like:

/**G
 * ## Description ##
 * Self-destruct
 **/
BEGIN_METHOD_VOID(SomeClass_Func)

	//...

END_METHOD

The documentation refers to the next line that begins with BEGIN_*.

NOTE that I only deduced the .info format from the gb.map.info file. I may
actually be wrong with my interpretation :-)

I already spoke with Sebastian about the .info -> wiki import functionality
but he's busy. Without the import facility, I don't see any great use of
committing the code up and it's 12K. Small enough for a mail attachment.

Regards,
Tobi

[0] http://sourceforge.net/mailarchive/message.php?msg_id=30152060

["gb-help.tar.gz" (application/octet-stream)]

------------------------------------------------------------------------------
Introducing AppDynamics Lite, a free troubleshooting tool for Java/.NET
Get 100% visibility into your production application - at no cost.
Code-level diagnostics for performance bottlenecks with <2% overhead
Download for free and get started troubleshooting in minutes.
http://p.sf.net/sfu/appdyn_d2d_ap1

_______________________________________________
Gambas-devel mailing list
Gambas-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/gambas-devel


[prev in list] [next in list] [prev in thread] [next in thread]