Skip to content

Conversation

Copy link

Copilot AI commented Nov 12, 2025

Added comprehensive Doxygen-style documentation to Colour.h and Planet.h header files to improve code maintainability and API clarity.

Changes

Colour.h

  • Class description for RGBA colour representation with normalized [0.0, 1.0] components
  • Member variable documentation for red, green, blue, alpha fields
  • Method documentation for constructors (float/unsigned short variants), operators, and all getters/setters

Planet.h

  • Class descriptions for Planet and nested Orbit classes
  • Member variable documentation for orbital parameters (aphelion, perihelion, period, inclination) and planet properties (name, radius, axial tilt, colour, satellites)
  • Method documentation for all constructors, destructors, and accessor methods

Example

/**
 * @class Colour
 * @brief Represents a colour with red, green, blue, and alpha (transparency) components.
 *
 * Component values are internally stored as floats normalized to the range [0.0, 1.0].
 */
class Colour {
    float red;    ///< Red component, normalized to range [0.0, 1.0]
    float green;  ///< Green component, normalized to range [0.0, 1.0]
    // ...
Original prompt

Add documentation to the header files


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits November 12, 2025 14:42
Co-authored-by: mikelrob <3390342+mikelrob@users.noreply.github.com>
Co-authored-by: mikelrob <3390342+mikelrob@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation to header files Add Doxygen documentation to header files Nov 12, 2025
Copilot AI requested a review from mikelrob November 12, 2025 14:45
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