Back to all reviewers

Document public API completely

maplibre/maplibre-native
Based on 5 comments
Other

All public APIs (files in `include/`) must have comprehensive documentation using either Doxygen-style or triple-slash comments. Documentation should include:

Documentation Other

Reviewer Prompt

All public APIs (files in include/) must have comprehensive documentation using either Doxygen-style or triple-slash comments. Documentation should include:

  1. Class-level documentation describing purpose and usage
  2. Method documentation with parameters, return values, and behavior
  3. Enum documentation including individual value descriptions
  4. Clear indication of public vs private API boundaries

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.

5
Comments Analyzed
Other
Primary Language
Documentation
Category

Discussion Thread