Document planar figure properties
Closed, ResolvedPublic
Actions

Assigned To

None

Authored By

	• goch
	May 25 2011, 5:03 PM

Description

To work on this bug you will have to branch from/merge into
bug-8203-provide-module-documentation

What should (at least) be done:
Add the following folders to the module.
If no module fits add it to an appropriate bundle.

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

and the file
Modules/YourModuleName/Documentation/doxygen/DiffusionImagingProperties.dox

A template of the property page including some of what should be explained therein:

/**
\page PlanarPropertiesPage The Planar Figure Properties

TODO
ClosedPlanarPolygon - is the polygon closed
planarfigure.ishovering - seems to be used by some interactors for
changing colors when the mouse hovers over an object.

*/

Additionally you will need to add your page to
\MITK\Documentation\Doxygen\Modules.dox
as a subpage by as demonstrated by
\subpage PropertiesPage

Related Objects
Search...

Status	Assigned	Task
Resolved	None	T8203 Provide documentation for the modules
Resolved	None	T8093 Documentation for properties
Wontfix	kislinsk	T5748 Default elements and color properties for varying states of items
Resolved	None	T8215 Document planar figure properties

Event Timeline

• goch added projects: MITK, Bugzilla.May 25 2011, 5:03 PM

The file should of course be named something like
Modules/YourModuleName/Documentation/doxygen/PlanarFigureProperties.dox

Does it make sense, to document the two properties (see above) and accordingly to have the two properties in the property list at all? As far as we know, "IsHovering" only reacts on the position of the mouse and ClosedPlanarPolygon is not listed in the property list.

How is the status if this bug? Have you spoken to MINT Anja?

We just saw, that the properties for planar figure changed a lot and many propeties appear in the property list. A new documentation has now to be written. Therefore we assign it to the documentation group.
We had already added an empty framework for the planar figure documentation which can be checked out with bug "bug-8215-planar-figure-property-doc"

[1528aa]: Merge branch 'bug-8215-add-planar-figure-property-doc'

Merged commits:

2011-09-07 15:14:48 Caspar Goch [03ff59]
Added Planar figure property page

kislinsk mentioned this in T27033: Clean up stale remote branches.Jan 25 2020, 9:01 PM

Document planar figure propertiesClosed, ResolvedPublicActions