Difference between revisions of "Documentation/Nightly/Developers/Tutorials/DocumentModule"
From Slicer Wiki
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887) |
m |
||
| Line 1: | Line 1: | ||
<noinclude>{{documentation/versioncheck}}</noinclude> | <noinclude>{{documentation/versioncheck}}</noinclude> | ||
{{:Documentation/{{documentation/version}}/HowTo}} | {{:Documentation/{{documentation/version}}/HowTo}} | ||
| + | |||
| + | {{:Documentation/{{documentation/version}}/Developers/FAQ/WritingDocumentation|Writing Documentation}} | ||
Latest revision as of 16:40, 15 July 2015
Home < Documentation < Nightly < Developers < Tutorials < DocumentModule
|
For the latest Slicer documentation, visit the read-the-docs. |
| 3D Slicer | |
|---|---|
 | |
| Description | |
| Research platform for the analysis and visualization of medical images, including image guided therapy. | |
| Free and extensible open source package. | |
| Multi-platform | Linux, MacOSX, Windows |
| Version | Nightly |
| License | Contribution and Software License Agreement |
Module page
This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation
Extension page
This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation
Developer FAQ: Writing Documentation
How to reference module or extension documentation hosted on the Slicer wiki ?
The URL including the Nightly namespace should be used.
Good: https://www.slicer.org/wiki/Documentation/Nightly/Modules/GaussianBlurImageFilter Poor: https://www.slicer.org/wiki/Documentation/4.4/Modules/GaussianBlurImageFilter References to documentation hosted on the wiki usually occurs when:
- writing module or extension description
- setting the documentation URL in
CMakeLists.txt, cpp or python source files.
Rational: This will facilitate maintenance and avoid to update source files after each release.
