docs: add doxygen documentation to get_points in pgdata_getters.hpp

[withaman69]

Fixes #973

Adds complete Doxygen documentation (@PARAM, @returns, and a usage
example) to get_points() in cpp_common/pgdata_getters.hpp, matching
the detail already present in pgdata_getters.cpp.

Note: points_input.c/.h referenced in the original issue no longer
exist — this functionality now lives in pgdata_getters.hpp/.cpp
alongside 13 other getter functions merged from various now-removed
files. To keep this PR focused, only get_points() is documented here.

Changes proposed in this pull request:

• Added @PARAM and @returns tags for get_points()
• Preserved the existing SQL usage example from the .cpp file

Summary by CodeRabbit

• Documentation
  • Expanded get_points documentation with a point-query example.
  • Added details about SQL parameters and the return type.

[coderabbitai]

Walkthrough

The PR expands the get_points Doxygen documentation with a query example, SQL parameter details, SQL shape, and return type information. It does not change declarations or behavior.

Changes

get_points documentation

Layer / File(s)	Summary
Document get_points API include/cpp_common/pgdata_getters.hpp	The documentation describes point-row queries, the SQL shape, the SQL input parameter, and the Point_on_edge_t vector return type.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

• pgRouting/pgrouting#3125: Both PRs expand Doxygen documentation for public helper APIs without changing signatures or behavior.

Poem

A rabbit reads the docs with care,
get_points answers questions there.
SQL shapes and types now hop,
Clear examples never stop.
No code changed—just wisdom grows!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	The change documents get_points, the current location of the points input functionality requested by issue #973.
Out of Scope Changes check	✅ Passed	The pull request only adds documentation for get_points and contains no unrelated code changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: adding Doxygen documentation to get_points() in pgdata_getters.hpp.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@include/cpp_common/pgdata_getters.hpp`:
- Around line 111-114: Update the get_points declaration to name its const
std::string& parameter sql, matching the existing `@param`[in] sql documentation.
- Around line 106-109: Update the SQL example documented near get_points in
pgdata_getters.hpp by adding a comma between fraction and side, so the SELECT
explicitly returns pid, edge_id, fraction, and side as four columns.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b4bb97e9-ace8-4a35-9eea-4b6d97dd95ef

📥 Commits

Reviewing files that changed from the base of the PR and between df6e9ee and bda75ba.

📒 Files selected for processing (1)

• include/cpp_common/pgdata_getters.hpp

[cvvergara]

You don't have your actions running.
The other PR has many errors, so I guess t his one will also generate many errors
Please activate your actions.
Make sure they pass.