-
Notifications
You must be signed in to change notification settings - Fork 20
Closed
Labels
class::documentationImprovements or additions to documentationImprovements or additions to documentationprio::lowThe priority of this task is low. It is an interesting item but with low priority.The priority of this task is low. It is an interesting item but with low priority.
Description
In order to improve documentation we should have:
- short description of every object, function, ...
- where is it defined/declared
- Parameters used (in/out, description, maybe also range/list of valid values but this would rather be something only in the examples since this can change for every examle)
- Code structure
- links/references to overloads
- inheritance diagramms
- searchable! (e.g. provide searchable pdf)
- separate enduser manual and a quick-start-guide
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
class::documentationImprovements or additions to documentationImprovements or additions to documentationprio::lowThe priority of this task is low. It is an interesting item but with low priority.The priority of this task is low. It is an interesting item but with low priority.