crust-firmware / crust

SCP (power management) firmware for sunxi SoCs
Other
155 stars 34 forks source link

Build searchable documentation from doc comments #172

Closed smaeul closed 4 years ago

smaeul commented 4 years ago

Type of issue

Enhancement

Description

There is documentation in Javadoc-style Doxygen-format comments for most public functions. However, there is no integration with a tool to turn that into readable/browseable/searchable API documentation. Since the comments are Doxygen format, that would be the most obvious tool to integrate. It should integrate with the main Makefile, and be verified to interpret our doc comments correctly.

smaeul commented 4 years ago

Closed by #180