Currently the state of the documentation for the modules tends to be close to non-existing. this should be changed and to further this a common policy for documentation should be implemented.
Description
Description
| Status | Assigned | Task | ||
|---|---|---|---|---|
| Resolved | None | T8203 Provide documentation for the modules | ||
| Resolved | None | T8093 Documentation for properties | ||
| Resolved | None | T8213 Document the point set properties | ||
| Resolved | None | T8215 Document planar figure properties | ||
| Restricted Maniphest Task | ||||
| Resolved | None | T8214 Document segmentation properties | ||
| Resolved | None | T8328 Document surface properties | ||
| Resolved | None | T8212 Document the diffusion imaging properties | ||
| Resolved | None | T7569 Create User Manuals for Bundles IGTTrackingToolBox and IGTNavigationToolManagement | ||
| Resolved | None | T9159 Write overview documentation for IGT |
Event Timeline
Comment Actions
I would suggest a structure similar to the bundles:
Modules/YourModuleName/Documentation/doxygen/
for any files describing how to interact with the module as a developer
Modules/YourModuleName/Documentation/UserManual/
for any files describing how to interact with the module as a user
The doygen/ folder should for example contain information on all the new properties introduced in this module.
Comment Actions
(In reply to comment #2)
Igi + Thomas: TODO push the new docu
pushed:
remote: Update hook checks refs/heads/bug-8203-provide-module-documentation ...
remote: refs/heads/bug-8203-provide-module-documentation is topic branch
To git@mbits:MITK
208f7f6..ef1a473 HEAD -> bug-8203-provide-module-documentation
Comment Actions
[7c8cb3]: Merge branch 'bug-8203-provide-module-documentation'
Merged commits:
2011-07-27 16:32:46 Caspar Goch [355508]
Improved documentation
2011-07-27 15:40:24 Caspar Goch [4e4520]
Merge remote-tracking branch 'origin/bug-8203-provide-module-documentation' into bug-8203-provide-module-documentation
2011-06-15 17:35:56 Ignaz Reicht [ef1a47]
enhanced property description
2011-06-14 11:06:25 Caspar Goch [d32ed3]
Merge remote-tracking branch 'origin/bug-8259-use-ctk-plugin-framework' into bug-8203-provide-module-documentation
2011-06-01 17:02:40 Thomas Kilgus [208f7f]
Added docu for color and started docu for opacity, layer and use lut
2011-06-01 15:25:53 Caspar Goch [17ab35]
Added some more properties in the appropriate places
2011-05-25 16:59:47 Caspar Goch [5e32c0]
Created template Property page
Comment Actions
[7f349b]: Merge branch 'bug-8203-provide-module-documentation'
Merged commits:
2011-07-28 11:25:49 Caspar Goch [ef25ac]
Layout changes
Comment Actions
[a3bf2d]: Merge branch 'bug-8203-provide-module-documentation'
Merged commits:
2011-07-29 13:03:20 Caspar Goch [0cf0fc]
More layouting