Skip to content

docs: add doxygen documentation to get_points in pgdata_getters.hpp #3126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
withaman69 wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

docs: add doxygen documentation to get_points in pgdata_getters.hpp #3126

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bda75ba
docs: add full doxygen documentation to get_points in pgdata_getters.hpp
withaman69 Aug 6, 2026
c00fd18
docs: fix SQL example comma and name sql parameter per review
withaman69 Aug 6, 2026
4a6f623
chore: trigger CI after enabling Actions
withaman69 Aug 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions include/cpp_common/pgdata_getters.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,18 @@ std::vector<IID_t_rt> get_matrixRows(const std::string&);
/** @brief Reads the pick-Deliver orders */
std::vector<Orders_t> get_orders(const std::string&, bool);

/** @brief Read rows of points */
std::vector<Point_on_edge_t> get_points(const std::string&);
/**
* @brief Read rows of points
*
* For queries of the type:
* ~~~~{.c}
* SELECT pid, edge_id, fraction, side FROM points;
* ~~~~
Comment thread
coderabbitai[bot] marked this conversation as resolved.
*
* @param[in] sql The points query
* @returns vector of `Point_on_edge_t`
*/
std::vector<Point_on_edge_t> get_points(const std::string& sql);

/** @brief Read rows of matrix */
std::vector<Restriction_t> get_restrictions(const std::string&);
Expand Down