Re: [Numpy-discussion] Extending documentation to c code

Hi,

ma, 2010-05-24 kello 12:01 -0600, Charles R Harris kirjoitti:

I'm wondering if we could extend the current documentation format to the c source code. The string blocks would be implemented something like

[clip]

I'd perhaps stick closer to C conventions and use something like

/** * Spam foo out of the parrots. * * Parameters * ---------- * a * Amount of spam * b * Number of parrots */ int foo(int a, int b) { }

Using some JavaDoc-type syntax might also be possible, although I personally find it rather ugly. Also, parsing C might not be too difficult, as projects aimed doing that in Python exist, for instance http://code.google.com/p/pycparser/