Re: [Gambas-user] Wiki documentation batch
Brought to you by:
gambas
From: Tobias B. <ta...@gm...> - 2012-11-30 22:47:57
|
> > > That way, at least components written in Gambas could be first > > > documented inside the source code. > > > > > > For the components written in C/C++, we need a tool that extracts the > > > help comments from the source code and put them in the *.info file the > > > same way the Gambas compiler does. > > Concerning that tool, wouldn't a simple sed or awk script suffice? Is there > any reference for this markdown derivate for Gambas (found nothing obvious > in the wiki)? I imagine that this tool can be done completely in some hours, > at most. Oh, I had a look again at the thread where you introduced that new syntax and someone pointed to an example of this documentation syntax in the IDE. I have looked into a .info file made by the compiler out of a documented component and wrote an awk script that does similar things for C/C++ Gambas sources. You just get the output, I don't know what to do with it further, especially in what concrete format the information has to be (like the .info files with name, type of symbol, documentation?) However, I set down some rules for the C/C++ documentation (feel free to object): - Those comments must begin with "/**" on a single line - They must end with " **/" on a line of itself - They must relate to the next line beginning with "BEGIN_" I grep'd for the /** and **/ patterns in the whole source tree. The latter was never found, the former sometimes. Let me know if you are interested/I can improve/reformat/... Regards, Tobi |