Skip to content

Review and enhance module documentation #648

@roggo

Description

@roggo

Every INAC Module must documented. Each module has a header in include/libinac and should have a corresponding markdown file with the same name under doc. Exception lib.h -> inac.md

Whenever possible a Module documentation should have at least 3 section.

  • Introduction: Containing purpose
  • Overview: Describing Module more in detail
  • Usage: API usage with sample code

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions