One topic discussed at the Pike Camp was documentation. With the beginners book just around the corner and the module tree documentation almost complete, the lack of documentation of the C API was deemed the most important area to improved. Thus we decided to immideatly try out doxygen for this, and as an experiment we documented array.[ch] and generated this: http://pike.ida.liu.se/generated/manual/c_api/html/index.html
To not clash with autodoc, only the /** syntax is used, and not the /*! one.
Comments?
Excellent! I've missed docs for the C API :)
Martin Nilsson (DivX Networks) @ Pike (-) developers forum wrote:
One topic discussed at the Pike Camp was documentation. With the beginners book just around the corner and the module tree documentation almost complete, the lack of documentation of the C API was deemed the most important area to improved. Thus we decided to immideatly try out doxygen for this, and as an experiment we documented array.[ch] and generated this: http://pike.ida.liu.se/generated/manual/c_api/html/index.html
To not clash with autodoc, only the /** syntax is used, and not the /*! one.
Comments?
Why is autodoc not used - any technical reasons? I don't really care - i'm just curious.
pike-devel@lists.lysator.liu.se