Details
-
Type:
Improvement
-
Status:
Open
-
Priority:
Critical
-
Resolution: Unresolved
-
Affects Version/s: 3.0.0 Beta 1
-
Fix Version/s: 3.0.1
-
Component/s: None
-
Labels:None
-
Acceptance Test - Add?:No
Description
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.