Uploaded image for project: 'NetarchiveSuite'
  1. NetarchiveSuite
  2. NAS-9 Switch to Confluence as the NetarchiveSuite wiki
  3. NAS-1857

Move parts of the current code centric wiki documentation to the Javadoc.

    XMLWordPrintable

Details

    • Sub-task
    • Resolution: Fixed
    • Minor
    • I48
    • None
    • Documentation
    • 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.

      Attachments

        Activity

          People

            mss Mikis Seth Sørensen (Inactive)
            mss Mikis Seth Sørensen (Inactive)
            Søren Vejrup Carlsen Søren Vejrup Carlsen (Inactive)
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - 6h
                6h
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 1h Time Not Required
                1h