Hi Damien, Nice that you work on documentation.
If you document salframe in very high level, then my comments do not apply. But if you document the code on function level (i.e. what each function does), then could you please use the same format for the wiki documentation that the actual source code would use: For style, look at this example: http://www.openoffice.org/nonav/issues/showattachment.cgi/41972/iCAIRO-canvas.patch Especially the /** **/ blocks just before the function(s). If you use the same style, it is possible to create automatically API documentation to the web from those comments. The style is standard docbook(?) comments, @ is for function variables etc. Creating those blocks would make it much easier to integrate (at later time) your documentation to the actual source code, where it helps the most. Mox On 2/21/07, Damien Duportal <[EMAIL PROTECTED]> wrote:
IH Tino, ih eric ! I'm completely agree with you Tinon, but in case of i'm newbie, i want to begin by wiki, where we can write in collaboration and correct some errors etc... (and my english's too bad :-D ) In my advise, when we'll have a stable and general documentation of vcl, putting it in the headers would be nice, but i think it's too prematured to put it now... Thanks for comments ;-) Damien --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
-- Mox on G
