##Task ## If any of the below links or sections are not applicable to your page, then please comment them out rather than deleting ## as they may become relevant later on. = D.1.2. Guidelines for Javadoc = ## Valid states: "Not started", "In progress" and "Finished" '''State:''' Finished ## The time used is measured in man days and does not include the time spent on any sub-tasks. '''Time used:''' 0 md. == Description == ## Add a high level task (goals / sub-goals) description here, sufficiently detailed to provide a background for creation of action descriptions. ## Any available (technical) details goes into the below documentation pages. Write guidelines for how and when the developers should write Javadoc in the code. ##== Sub tasks == ## . [:TaskX.Y.Z: Add sub task link 1 here] ## . [:TaskX.Y.Z: Add sub task link 2 here] ## . ..[[BR]] ## . ..[[BR]] ## . .. ## . [:TaskX.Y.Z: Add sub task link N here] == Documentation == ## The documentation section links to the documentation relevant to this task and its sub-tasks (if any). ## ## The below links will automatically be expanded to page names like "MyTaskPageNameAnalysisDocument" in your created page. ## This should be a proper default, however, it may be changed. * [[TaskD.1.2AnalysisDocument| Analysis Document]] * [[TaskD.1.2DesignDocument| Design Document]] * [[TaskD.1.2SystemMaintenanceDocument| System Set-up and Maintenance Document]] == Parent task == * [[TaskD.1]] == Progress history == <> ## Add information about about the current state of the task here. That is, information about what has been completed so far and ## what outstanding issues that are left. Example: ## ##=== 2007-09-13 === ##Finished the design documentation. A review is needed before this task can is completed. ## ##=== 2007-08-25 === ##Completed requirement specification. We are now ready for writing the design document. === 2007-09-13 === * The page [[Javadoc Guidelines]] has been generated and is considered finished in the scope of this task. * The CodeStyle page also provides a setup file for IntelliJ, which accommodates formatting of javadoc.