(utils) Documentation of Arduino code
Closed this issue · 7 comments
It should be in two levels one should be like an abstract and the other one should have detailed explanation for each function. It will help new members to contribute.
@pkhrag @shibhansh The abstract one should go to auvWiki and detailed explanation of each function should be as Doxygen docs so that we can use it to auto generate html doc pages. Please read devloper guide : documentation. I feel arduino code is a good place to start with documentation. Also @shibhansh @pkhrag Just remember code documentation should address the question of why a function exists not what is does.
I will write something for website so tell beforehand what you expect from it. I.E in the article(detailed one)
Read the comment from @shibhansh, though please make it more clear, i.e how much maths behind the methods (or just links to the documentation of the functions for the same), what you want to mean by how to use the algorithm. What should be the ideal length so that there can be an exact format for all documentations
The doc should explain what the overall algorithm does and how. Not the explanation of how functions do what they do but just what the functions are. Like you could say that you do contrast stretching -> thresholding -> cannyEdge detection -> bla bla bla
@siddsax for the code part it should do as @ShikherVerma said.
I will suggest that we should give the links wherever there is some algorithm. Also for IP nodes we can include the results in the documentation.