All public APIs (files in `include/`) must have comprehensive documentation using either Doxygen-style or triple-slash comments. Documentation should include:
All public APIs (files in include/
) must have comprehensive documentation using either Doxygen-style or triple-slash comments. Documentation should include:
Example:
/// This enum defines color blending equations
enum class ColorBlendEquationType : uint8_t {
Add, ///< Adds source and destination colors
Subtract, ///< Subtracts destination from source color
ReverseSubtract ///< Subtracts source from destination color
};
/**
* @brief Adds a polyline to the drawable layer
*
* @param coordinates Geographic coordinates of the polyline
* @return true if polyline was successfully added, false otherwise
*/
bool addPolyline(const LineString<double>& coordinates);
Private implementation files (in src/
) may have lighter documentation, focusing on complex logic or non-obvious implementations.
Enter the URL of a public GitHub repository