Skip to content

Conversation

@zfields
Copy link
Contributor

@zfields zfields commented Oct 23, 2025

Migrated and improved language of API documentation.

@zfields zfields requested review from Bucknalla and Copilot October 23, 2025 19:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR consolidates public API documentation by moving it from the .cpp implementation file to the .h header file, making the documentation more accessible to users and tools that inspect header files.

Key Changes:

  • Moved all Doxygen-style documentation blocks from Notecard.cpp to Notecard.h
  • Updated some documentation descriptions to be more precise and consistent
  • Removed redundant documentation from the implementation file

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
src/Notecard.h Added comprehensive Doxygen documentation blocks for all public API methods
src/Notecard.cpp Removed documentation blocks now present in the header file; updated one existing doc block for clarity

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@zfields zfields merged commit 31fa684 into master Oct 24, 2025
94 checks passed
@zfields zfields deleted the zak-api branch October 24, 2025 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants