Doxygen

[PX]

Hello!

I'm developing my first open source app in lazarus,
and I've heard that you should use doxygen to document it, which of what I understand makes HTML files like:

which takes

Code: [Select]


program HWorld;
procedure HelloWorld()
(**
* prints Hello world to the user
**)
begin
write('Hello');
end;

function GooByeWorld: integer()
(**
* kills the program
**)
begin
exit();
end.
//Sorry my pascal is rusty

and makes

procedure HelloWorld - prints Hello world to the user
function GooByeWorld: integer - kills the program


However I understand theres a LazDoc program that does the same, but I cant seem to find any info on how to use it from Lazarus, could anyone explain to me how its used (or where I can find a FAQ that actually explains it)

Thanks

[antonio]

http://wiki.lazarus.freepascal.org/LazDoc

[PX]

I read that and went to view -> lazdoc and then it asks me for title and description but not for a specific function?

[antonio]

Do you want a specific function?

[PX]

I want to commen each function like: http://msdn.microsoft.com/archive/default.asp?url=/archive/en-us/dnarvb4/html/msdn_shelexec.asp

Well not as advanced, but like list all functions, explain what they do and show their parameters