Skip to content

Add Doxygen comments to undocumented NK_API declarations #212

@RobLoach

Description

@RobLoach

The Doxygen wiki workflow added in #181 generates docs, but several NK_API functions in nuklear_console.h lack a /** ... */ block above the declaration (e.g., nk_console_layout_widget, nk_console_button_pushed, nk_console_button_down), so they ship to the wiki with no description. Additionally, the README "API" snippet doesn't list these, so users have no entry point.

Suggested Implementation

  • Sweep NK_API declarations in nuklear_console.h and the widget headers; add one-line Doxygen comments to the undocumented ones.
  • Regenerate README.md's API block (or replace it with a link to the generated wiki — moxygen is already in CI).

QA

  • grep -B1 "^NK_API" *.h | grep -c "\*/" ≈ count of NK_API declarations.
  • Doxygen run produces no "undocumented" warnings.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions