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.

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

Jump to bottom

Doxygen improvements to improve documentation of C API #2355

Merged
merged 3 commits into from
Jul 5, 2022
Merged

Doxygen improvements to improve documentation of C API #2355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f0442a
Add modules to doxygen comments, create C API module
ChuckHastings Jun 15, 2022
7bf2a2c
Remove CURRENT_SHORT_TAG from regex check
ChuckHastings Jun 30, 2022
802f3de
fix regex syntax
ChuckHastings Jun 30, 2022
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
2 changes: 1 addition & 1 deletion ci/release/update-version.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ for FILE in conda/environments/*.yml; do
done

# Doxyfile update
sed_runner "s|\(TAGFILES.*librmm/\).*|\1${NEXT_SHORT_TAG}|" cpp/doxygen/Doxyfile
sed_runner "s|PROJECT_NUMBER[[:space:]]*=.*|PROJECT_NUMBER=${NEXT_SHORT_TAG}|" cpp/doxygen/Doxyfile

# ucx-py version
sed_runner "s/export UCX_PY_VERSION=.*/export UCX_PY_VERSION='${NEXT_UCX_PY_VERSION}'/g" ci/benchmark/build.sh
Expand Down
4 changes: 2 additions & 2 deletions cpp/doxygen/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ PROJECT_NAME = "libcugraph"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 0.14
PROJECT_NUMBER = 22.08

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF =
PROJECT_BRIEF = GPU accelerated graph analytics

# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
Expand Down
8 changes: 8 additions & 0 deletions cpp/include/cugraph/algorithms.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@
#include <raft/random/rng_state.hpp>
#include <raft/span.hpp>

/** @ingroup cpp_api
* @{
*/

namespace cugraph {

/**
Expand Down Expand Up @@ -1572,3 +1576,7 @@ void triangle_count(raft::handle_t const& handle,
bool do_expensive_check = false);

} // namespace cugraph

/**
* @}
*/
8 changes: 8 additions & 0 deletions cpp/include/cugraph/graph.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@
#include <type_traits>
#include <vector>

/** @defgroup cpp_api cuGraph C++ API
* @{
*/

namespace cugraph {

template <typename vertex_t, typename edge_t, typename weight_t>
Expand Down Expand Up @@ -551,3 +555,7 @@ __host__ __device__ std::enable_if_t<std::is_unsigned<vertex_t>::value, bool> is
} // namespace cugraph

#include "eidecl_graph.hpp"

/**
* @}
*/
Loading