SRL Archive - Suggestions

In-code documentation


Wizzup?

2010-09-04 04:49:07

Hi,

I think it's time we settled on a specific format for source code documentation.
Personally I don't really feel the need to this ``API'' alike documentation for all the Simba functions. With the @args and all, no one will call these functions directly. I'm more in for a story on how the functions are supposed to work; and specific things can simply be looked up in the source code. The last time I stated thing I don't think everyone agreed with me, so let's pick a standard anyway and write some in code documentation as well. I don't think it can hurt.

( http://bugs.villavu.com/view.php?id=117 )

Wizzup?

2010-09-04 09:30:09

Pushed makefile for documentation + a start for the documentation: http://wizzup.org/simbafpcdoc

At the moment really only os_linux is documented.

I'm using the FPDoc Editor in Lazarus, I suggests everyone else does the same.

nielsie95

2010-09-04 09:37:14

Nice :)

Wizzup?

2010-09-04 17:36:13

It looks like we can place the "Description" (the larger text) as a comment just before the declaration.

Wizzup?

2010-09-05 18:40:57

Threw in a lot more units, not all have short descriptions / descriptions.
http://wizzup.org/simbafpcdoc/

Wizzup?

2011-01-09 06:51:44

Bump.