Skip to content

feat(Cluster): Add comprehensive DocC documentation#562

Merged
boilerwadding merged 5 commits intomain-swiftfrom
SB/cluster-docc-documentation
Oct 20, 2025
Merged

feat(Cluster): Add comprehensive DocC documentation#562
boilerwadding merged 5 commits intomain-swiftfrom
SB/cluster-docc-documentation

Conversation

@iHackSubhodip
Copy link
Copy Markdown
Collaborator

What's changing:

Adds complete DocC documentation for Cluster module in GoogleMapsUtils following Apple's documentation standards.

Documentation Added:

Cluster Module:

  • Enhanced all Cluster public APIs with proper DocC comments
  • Created ClusteringDocumentation.swift for module-level organization

Technical Changes:

  • Ensured consistent formatting across all Cluster files
  • All public APIs properly documented with DocC syntax

Testing:

  • ✅ All module builds successfully
  • ✅ DocC generates without warnings
  • ✅ All public APIs properly documented
  • ✅ Documentation renders correctly in Xcode

Next Steps:

Follow-up PR needed: Add GitHub Actions workflow (.github/workflows/docc.yml) to automatically deploy DocC documentation to GitHub Pages at https://googlemaps.github.io/google-maps-ios-utils/

Documentation from Xcode

Screenshot 2025-10-18 at 1 52 17 PM

# Conflicts:
#	GoogleMapsUtils.xcodeproj/project.pbxproj
#	Sources/GoogleMapsUtils/GeometryUtils/Documentation/GeometryUtilsDocumentation.swift
#	Sources/GoogleMapsUtils/Heatmap/WeightedLatLng/GMUWeightedLatLng.swift
#	Sources/GoogleMapsUtils/QuadTree/Documentation/QuadTreeDocumentation.swift
#	Sources/GoogleMapsUtils/QuadTree/PointQuadTree/GQTPointQuadTree.swift
#	Sources/GoogleMapsUtils/QuadTree/PointQuadTreeChild/GQTPointQuadTreeChild.swift
@boilerwadding boilerwadding merged commit 1cb43b4 into main-swift Oct 20, 2025
9 checks passed
@boilerwadding boilerwadding deleted the SB/cluster-docc-documentation branch October 20, 2025 15:09
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