Skip to content

Improve documentation #48

@mknaranja

Description

@mknaranja

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    class::documentationImprovements or additions to documentationprio::lowThe priority of this task is low. It is an interesting item but with low priority.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions