Le 27/07/2012 09:43, nap a écrit :
On Thu, Jul 26, 2012 at 10:48 PM, Hartmut Goebel <h.goe...@crazy-compilers.com <mailto:h.goe...@crazy-compilers.com>> wrote:Am 26.07.2012 17 <tel:26.07.2012%2017>:04, schrieb Timo Veith: > is there a code documentation or any plans on doing so? Prior to using a tool like sphinx, we need to add usual doc-strings. Currently often comments are put in front of the function/method/class, but decent doc-strings are missing. See issue #99. Unfortunately Shinken is lacking here.And I don't plan to add them unless someone explain me why it's a good idea to put a explanation about a function between the prototype and the code.
All automatic tool looking for python documentation expect to find them here. pydoc, epydoc, pylint, ... will be happy with that. And personnaly I use pydoc a lot when writing code. Users should not have to open the source file to know how to use the API. (Do you read glibc C source files to find the doc for fcntl() ? ;))So I would advise to switch to python docstrings, or, have you own tool which parses and detect your own documentation style (doxygen?) and reports API doc to users, easily.
Aurélien
------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________ Shinken-devel mailing list Shinken-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/shinken-devel
