Details
-
Sub-task
-
Resolution: Fixed
-
Minor
-
None
-
None
-
General
-
Rough
Description
The motivation for doing this is to:
- Trim the wiki based documentation.
- Cut down on documentation maintenance by using javadocs inherit code integration properties.
- Put the code near documentation in the same version control system as the code itself, thereby creating a consistent and automatic minding between the two.
- Adding this documentation to the Crucible code review process which should increase the quality of this information.
- Increasing the likelihood of code changes leading to updates in the documentation as the two are now maintained in the same file structure.