Skip to content
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.

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

Add Doxygen Documentation for libcuspatial #534

Merged
merged 14 commits into from
Jun 1, 2022
Prev Previous commit
Next Next commit
Address @vyasr PR comments.
  • Loading branch information
vyasr committed May 31, 2022

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
commit 613cb0f469d8f13d5e88eb82d7b4b016e3193114
6 changes: 3 additions & 3 deletions cpp/include/cuspatial/distances/linestring_distance.hpp
Original file line number Diff line number Diff line change
@@ -88,9 +88,9 @@ namespace cuspatial {
* @param linestring1_offsets Indices of the first point of the first linestring of each pair
* @param linestring1_points_x x-components of points in the first linestring of each pair
* @param linestring1_points_y y-component of points in the first linestring of each pair
* @param linestring2_offsets Indices of the first point of the second linestring of each pair
* @param linestring2_points_x x-component of points in the first linestring of each pair
* @param linestring2_points_y y-component of points in the first linestring of each pair
* @param linestring2_offsets Indices of the second point of the second linestring of each pair
* @param linestring2_points_x x-component of points in the second linestring of each pair
* @param linestring2_points_y y-component of points in the second linestring of each pair
* @param mr Device memory resource used to allocate the returned column's device memory
* @return A column of shortest distances between each pair of linestrings
*
4 changes: 2 additions & 2 deletions cpp/include/cuspatial/experimental/type_utils.hpp
Original file line number Diff line number Diff line change
@@ -91,9 +91,9 @@ auto make_vec_2d_iterator(FirstIter first, SecondIter second)
*
* Interleaves longitude and latitude from separate iterators into a single iterator to lon/lat
* coordinates.
* @tparam FirstIter Iterator type to the first component of `lonlat_2d`. Must meet the requirements
* @tparam FirstIter Iterator type to the first component (the longitude) of `lonlat_2d`. Must meet the requirements
* of [LegacyRandomAccessIterator][LinkLRAI] and be device-accessible.
* @tparam SecondIter Iterator type to the second component of `lonlat_2d`. Must meet the
* @tparam SecondIter Iterator type to the second component (the latitude) of `lonlat_2d`. Must meet the
* requirements of [LegacyRandomAccessIterator][LinkLRAI] and be device-accessible.
* @param first Iterator to beginning of `lonlat_2d::x`
* @param second Iterator to beginning of `lonlat_2d::y`
4 changes: 2 additions & 2 deletions cpp/include/cuspatial/spatial_join.hpp
Original file line number Diff line number Diff line change
@@ -52,8 +52,8 @@ namespace cuspatial {
* @throw cuspatial::logic_error If max_depth is less than 1 or greater than 15
*
* @return A cudf table with two columns:
* poly_offset - INT32 column of indices for each poly bbox that intersects with the quadtree.
* quad_offset - INT32 column of indices for each leaf quadrant intersecting with a poly bbox.
* - poly_offset - INT32 column of indices for each poly bbox that intersects with the quadtree.
* - quad_offset - INT32 column of indices for each leaf quadrant intersecting with a poly bbox.
*/
std::unique_ptr<cudf::table> join_quadtree_and_bounding_boxes(
cudf::table_view const& quadtree,
2 changes: 1 addition & 1 deletion cpp/include/cuspatial/types.hpp
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@
namespace cuspatial {

/**
* @addtogroup type_definition_operator
* @addtogroup types
* @{
*/

2 changes: 1 addition & 1 deletion cpp/include/cuspatial/utility/vec_2d.hpp
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@
namespace cuspatial {

/**
* @addtogroup type_definition_operator
* @addtogroup types
* @{
*/

10 changes: 4 additions & 6 deletions cpp/include/doxygen_groups.h
Original file line number Diff line number Diff line change
@@ -84,12 +84,10 @@
* @}
* @defgroup cuspatial_types Types
* @{
* @defgroup type_definition_operator Definition and Operators
* @{
* @brief Type declarations for cuspatial
* @file types.hpp
* @file vec_2d.hpp
* @}
* @brief Type declarations for cuspatial
* @file types.hpp
* @file vec_2d.hpp
*
* @defgroup type_factories Factory Methods
* @{
* @brief Factory method to create coordinate iterators