Add documentation for the class fields #63
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds some basic documentation for the fields of each class provided by this library. The documentation has been reverse-engineered from experimentation and by reading the source code of the library.
I have been frustrated by the lack of documentation in this library, so I've dedicated the better part an afternoon to documenting this. I hope it will be useful to future users of the library.
Since there was no documentation for any fields at all, I've adapted the documentation style of the methods that were documented. The existing documentation was inconsistent in use of periods at the end so I've opted to just use periods there. Some fields appeared to be dysfunctional, so I've skipped documenting those.
Fixes #62