Use square brackets for documentation links

[peterstace]

Description

Go 1.19 introduced documentation links using square bracket syntax. This makes type and function references in doc comments clickable in generated documentation.

See https://tip.golang.org/doc/comment for details on the syntax.

Check List

Have you:

• Added unit tests? N/A

• Add cmprefimpl tests? (if appropriate?) N/A

• Updated release notes? (if appropriate?) N/A

Related Issue

• Update all comments to use square brackets for documentation links #669

[Copilot]

Pull request overview

This PR updates documentation comments throughout the codebase to use Go 1.19's square bracket syntax for type and function references. This modernizes the documentation by making type and function references clickable in generated documentation, improving discoverability and navigation.

Key changes:

• Type names now use [TypeName] instead of plain text TypeName
• Function/method references use [Type.Method] instead of plain text Method
• Package references like [database/sql.Scanner] replace plain text references

Reviewed changes

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

Show a summary per file

File	Description
rtree/rtree.go	Updated documentation links for RTree, Box, Stop, and method references
rtree/nearest.go	Updated documentation links for RTree and method references
rtree/bulk.go	Updated documentation link for RTree
proj/proj.go	Updated documentation links for Transformation and method references
internal/rawgeos/handle.go	Updated documentation link for geom.Geometry
internal/cmprefimpl/cmppg/postgis.go	Updated documentation link for PostGIS
internal/cmprefimpl/cmppg/pg.go	Updated documentation links for BatchPostGIS and UnaryResult
geos/entrypoints.go	Updated documentation links for Buffer, geometry types, and function references
geos/doc.go	Updated documentation link for geom.Geometry.Validate method
geom/xy.go	Updated documentation links for XY, Point, and vector operations
geom/wkt_parser.go	Updated documentation links for Geometry and NoValidate
geom/wkb_parser.go	Updated documentation links for Geometry and NoValidate
geom/type_sequence.go	Updated documentation links for Sequence, CoordinatesType, Coordinates, and XY
geom/type_polygon.go	Updated documentation links for Polygon, LineString, GeometryType, Geometry, and various methods
geom/type_point.go	Updated documentation links for Point, XY, Coordinates, GeometryType, Geometry, and various interface methods
geom/type_null_geometry.go	Updated documentation links for Geometry and database/sql interfaces
geom/type_multi_polygon.go	Updated documentation links for Polygon, GeometryType, Geometry, and various methods
geom/type_multi_point.go	Updated documentation links for MultiPoint, Point, GeometryType, Geometry, and various methods
geom/type_multi_line_string.go	Updated documentation links for LineString, GeometryType, Geometry, and various methods
geom/type_line_string.go	Updated documentation links for LineString, Sequence, Point, GeometryType, Geometry, and various methods
geom/type_geometry_collection.go	Updated documentation links for GeometryCollection, Geometry, and various geometry types
geom/type_geometry.go	Updated documentation links for Geometry, GeometryType, and various concrete types
geom/type_envelope.go	Updated documentation links for Envelope, XY, Geometry, and various geometry types
geom/type_coordinates.go	Updated documentation links for Coordinates and Point
geom/no_validate.go	Updated documentation links for NoValidate
geom/interval.go	Updated documentation links for Interval
geom/geojson_unmarshal.go	Updated documentation link for NoValidate
geom/geojson_feature_collection.go	Updated documentation links for Geometry and encoding/json interfaces
geom/de9im.go	Updated documentation link for Relate function
geom/ctor_from_coords.go	Updated documentation links for Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, and Validate methods
geom/coordinate_type.go	Updated documentation links for CoordinatesType
geom/alg_relate.go	Updated documentation links for Geometry values
carto/proj_web_mercator.go	Updated documentation link for WebMercator
carto/proj_utm.go	Updated documentation link for UTM
carto/proj_sinusoidal.go	Updated documentation link for Sinusoidal
carto/proj_orthographic.go	Updated documentation link for Orthographic
carto/proj_lambert_cylindrical_equal_area.go	Updated documentation link for LambertCylindricalEqualArea
carto/proj_lambert_conformal_conic.go	Updated documentation link for LambertConformalConic
carto/proj_equirectangular.go	Updated documentation link for Equirectangular
carto/proj_equidistant_conic.go	Updated documentation link for EquidistantConic
carto/proj_azimuthal_equidistant.go	Updated documentation link for AzimuthalEquidistant
carto/proj_albers_equal_area_conic.go	Updated documentation link for AlbersEqualAreaConic

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[albertteoh]

👍🏼

[peterstace]

Thanks for reviewing Albert!