docs: add full doxygen documentation to get_check_data.hpp

[withaman69]

Fixes #972 .

Adds complete Doxygen documentation (@PARAM, @throw, @return) to
get_check_data.hpp, matching the detail already present in
get_check_data.cpp. Header docs were previously limited to a single
@brief line per function.

Changes proposed in this pull request:

• Added @PARAM tags describing each function's inputs
• Added @return tags describing what each function returns
• Added @throw tags documenting error conditions

@pgRouting/admins

Summary by CodeRabbit

• Documentation
  • Expanded API documentation with parameter, return-value, precondition, and error descriptions.
  • Clarified usage expectations for public helper functions without changing their behavior.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 85a086fe-374c-4665-ad7e-20b54c929aef

📥 Commits

Reviewing files that changed from the base of the PR and between af76677 and f5ab906.

📒 Files selected for processing (1)

• src/cpp_common/get_check_data.cpp

---

Walkthrough

The change expands Doxygen documentation for public helpers in get_check_data.hpp and changes documentation-style comment delimiters in get_check_data.cpp. Function declarations and behavior remain unchanged.

Changes

get_check_data documentation

Layer / File(s)	Summary
Document public helpers include/cpp_common/get_check_data.hpp	Expanded Doxygen comments for column lookup, type extraction, PostgreSQL array conversion, numeric accessors, and text access.
Normalize implementation comments src/cpp_common/get_check_data.cpp	Changed comment delimiters for validation, lookup, array-processing, and accessor comments. Executable code remains unchanged.

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

Poem

A rabbit reads the docs with care,
Finds clear parameters everywhere.
Comments guide each code path bright,
While behavior stays just right.
No code hops, no paths rearrange—
Doxygen makes the helpers sage.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main change: adding full Doxygen documentation to get_check_data.hpp.
Linked Issues check	✅ Passed	The PR fulfills issue #972 by adding Doxygen documentation to the migrated C++ equivalents of the requested get_check_data files.
Out of Scope Changes check	✅ Passed	All changes support the documentation objective, including removing a duplicate Doxygen marker without changing behavior or APIs.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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: 1

🤖 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/get_check_data.hpp`:
- Around line 59-65: Update the Doxygen annotation for fetch_column_info to mark
info as [in,out], reflecting that get_column_info modifies each vector element’s
colNumber and type fields through the non-const reference.

🪄 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: d91f62ea-edcd-46bc-b52a-0716f009cfec

📥 Commits

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

📒 Files selected for processing (1)

• include/cpp_common/get_check_data.hpp

[withaman69]

Note: the files referenced in issue #972 (get_check_data.c and
get_check_data.h) no longer exist — the project migrated this code
to C++ (get_check_data.cpp / get_check_data.hpp) after the issue was
originally opened in 2017. This PR documents the current equivalent
files, which serve the same purpose. Happy to adjust scope if a
maintainer prefers a different approach.

[cvvergara]

Has many errors
https://github.com/pgRouting/pgrouting/actions/runs/30901475940/job/93109953693?pr=3125#step:10:42

Please fix.

[withaman69]

Fixed — converted the duplicate Doxygen-style comments in
get_check_data.cpp to plain comments (removed the extra /!/*
markers) so parameter docs aren't declared twice. Should resolve
the "multiple @PARAM documentation sections" warnings.