arduino-menusystem icon indicating copy to clipboard operation
arduino-menusystem copied to clipboard

Documentation

Open jonblack opened this issue 9 years ago • 2 comments

The library is getting a little more complex and the examples probably won't be enough to help newcomers.

Write some documentation and stick it up on readthedocs.org

jonblack avatar Jun 02 '16 13:06 jonblack

How about first adding documentation of each method in the header file? The header file is, after all, the first place where we usually look for API documentation.

If the header file has, for example, doxygen comments the generated files can be used as a base for higher level documentation at third-party sites.

eadf avatar Jun 02 '16 18:06 eadf

I've started added some doxygen style comments already. But you're right, that should be done here as well.

jonblack avatar Jun 03 '16 07:06 jonblack