A good documentation makes it easier for new developers to start using and perhaps join developing the library. Currently the most complained area in XIFF is the lack of documentation. In order to achieve more wider community and thus make the code more tested, the documentation needs to be somewhat complete.
I would suggest adding a use case example in the main comment of those classes where such can be done.
Environment
None
Activity
Show:
Juga Paazmaya
August 5, 2012 at 8:42 PM
"XIFF-105 - Inline examples for asdoc in most classes" will take it from here.
Juga Paazmaya
August 5, 2012 at 8:36 PM
Inline examples shall/might be added in the next release...
A good documentation makes it easier for new developers to start using and perhaps join developing the library.
Currently the most complained area in XIFF is the lack of documentation.
In order to achieve more wider community and thus make the code more tested, the documentation needs to be somewhat complete.
I would suggest adding a use case example in the main comment of those classes where such can be done.