Skip to content

Commit 64d5477

Browse files
Update doxygen comments to specify in,out instead of in/out (#4425)
Doxygen documentation warnings exist in the documentation builds. This fixes these errors. Closes #4328 Authors: - Chuck Hastings (https://github.com/ChuckHastings) Approvers: - Seunghwa Kang (https://github.com/seunghwak) URL: #4425
1 parent ac98ce7 commit 64d5477

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

cpp/include/cugraph/detail/shuffle_wrappers.hpp

+4-4
Original file line numberDiff line numberDiff line change
@@ -213,12 +213,12 @@ shuffle_int_vertex_value_pairs_to_local_gpu_by_vertex_partitioning(
213213
*
214214
* @param[in] handle RAFT handle object to encapsulate resources (e.g. CUDA stream, communicator,
215215
* and handles to various CUDA libraries) to run graph algorithms.
216-
* @param[in/out] d_edgelist_majors Vertex IDs for sources (if we are internally storing edges in
216+
* @param[in,out] d_edgelist_majors Vertex IDs for sources (if we are internally storing edges in
217217
* the sparse 2D matrix using sources as major indices) or destinations (otherwise)
218-
* @param[in/out] d_edgelist_minors Vertex IDs for destinations (if we are internally storing edges
218+
* @param[in,out] d_edgelist_minors Vertex IDs for destinations (if we are internally storing edges
219219
* in the sparse 2D matrix using sources as major indices) or sources (otherwise)
220-
* @param[in/out] d_edgelist_weights Optional edge weights
221-
* @param[in/out] d_edgelist_id_type_pairs Optional edge (ID, type) pairs
220+
* @param[in,out] d_edgelist_weights Optional edge weights
221+
* @param[in,out] d_edgelist_id_type_pairs Optional edge (ID, type) pairs
222222
* @param[in] groupby_and_count_local_partition_by_minor If set to true, groupby and count edges
223223
* based on (local partition ID, GPU ID) pairs (where GPU IDs are computed by applying the
224224
* compute_gpu_id_from_vertex_t function to the minor vertex ID). If set to false, groupby and count

cpp/include/cugraph_c/community_algorithms.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ cugraph_error_code_t cugraph_louvain(const cugraph_resource_handle_t* handle,
121121
* @param [in] handle Handle for accessing resources
122122
* @param [in] graph Pointer to graph. NOTE: Graph might be modified if the storage
123123
* needs to be transposed
124-
* @param [in/out] rng_state State of the random number generator, updated with each call
124+
* @param [in,out] rng_state State of the random number generator, updated with each call
125125
* @param [in] max_level Maximum level in hierarchy
126126
* @param [in] resolution Resolution parameter (gamma) in modularity formula.
127127
* This changes the size of the communities. Higher resolutions
@@ -181,7 +181,7 @@ void cugraph_hierarchical_clustering_result_free(cugraph_hierarchical_clustering
181181
* @brief Compute ECG clustering
182182
*
183183
* @param [in] handle Handle for accessing resources
184-
* @param [in/out] rng_state State of the random number generator, updated with each call
184+
* @param [in,out] rng_state State of the random number generator, updated with each call
185185
* @param [in] graph Pointer to graph. NOTE: Graph might be modified if the storage
186186
* needs to be transposed
187187
* @param [in] min_weight Minimum edge weight in final graph

cpp/include/cugraph_c/graph_generators.h

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2023, NVIDIA CORPORATION.
2+
* Copyright (c) 2023-2024, NVIDIA CORPORATION.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -120,7 +120,7 @@ void cugraph_coo_list_free(cugraph_coo_list_t* coo_list);
120120
* Vertex types will be int32 if scale < 32 and int64 if scale >= 32
121121
*
122122
* @param [in] handle Handle for accessing resources
123-
* @param [in/out] rng_state State of the random number generator, updated with each call
123+
* @param [in,out] rng_state State of the random number generator, updated with each call
124124
* @param [in] scale Scale factor to set the number of vertices in the graph. Vertex IDs have
125125
* values in [0, V), where V = 1 << @p scale.
126126
* @param [in] num_edges Number of edges to generate.
@@ -164,7 +164,7 @@ cugraph_error_code_t cugraph_generate_rmat_edgelist(const cugraph_resource_handl
164164
* Vertex types will be int32 if scale < 32 and int64 if scale >= 32
165165
*
166166
* @param [in] handle Handle for accessing resources
167-
* @param [in/out] rng_state State of the random number generator, updated with each call
167+
* @param [in,out] rng_state State of the random number generator, updated with each call
168168
* @param [in] n_edgelists Number of edge lists (graphs) to generate
169169
* @param [in] min_scale Scale factor to set the minimum number of verties in the graph.
170170
* @param [in] max_scale Scale factor to set the maximum number of verties in the graph.
@@ -204,8 +204,8 @@ cugraph_error_code_t cugraph_generate_rmat_edgelists(
204204
* Updates a COO to contain random edge weights
205205
*
206206
* @param [in] handle Handle for accessing resources
207-
* @param [in/out] rng_state State of the random number generator, updated with each call
208-
* @param [in/out] coo Opaque pointer to the coo, weights will be added (overwriting
207+
* @param [in,out] rng_state State of the random number generator, updated with each call
208+
* @param [in,out] coo Opaque pointer to the coo, weights will be added (overwriting
209209
* any existing weights)
210210
* @param [in] dtype The type of weight to generate (FLOAT32 or FLOAT64), ignored
211211
* unless include_weights is true
@@ -229,7 +229,7 @@ cugraph_error_code_t cugraph_generate_edge_weights(const cugraph_resource_handle
229229
* edges
230230
*
231231
* @param [in] handle Handle for accessing resources
232-
* @param [in/out] coo Opaque pointer to the coo, weights will be added (overwriting
232+
* @param [in,out] coo Opaque pointer to the coo, weights will be added (overwriting
233233
* any existing weights)
234234
* @param [in] multi_gpu Flag if the COO is being created on multiple GPUs
235235
* @param [out] error Pointer to an error object storing details of any error. Will
@@ -246,8 +246,8 @@ cugraph_error_code_t cugraph_generate_edge_ids(const cugraph_resource_handle_t*
246246
* Updates a COO to contain edge types. Edges types will be randomly generated.
247247
*
248248
* @param [in] handle Handle for accessing resources
249-
* @param [in/out] rng_state State of the random number generator, updated with each call
250-
* @param [in/out] coo Opaque pointer to the coo, weights will be added (overwriting
249+
* @param [in,out] rng_state State of the random number generator, updated with each call
250+
* @param [in,out] coo Opaque pointer to the coo, weights will be added (overwriting
251251
* any existing weights)
252252
* @param [in] max_edge_type Edge types will be randomly generated between min_edge_type
253253
* and max_edge_type

cpp/include/cugraph_c/sampling_algorithms.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ void cugraph_sampling_options_free(cugraph_sampling_options_t* options);
348348
* parameter is only used with the retain_seeds option.
349349
* @param [in] fanout Host array defining the fan out at each step in the sampling algorithm.
350350
* We only support fanout values of type INT32
351-
* @param [in/out] rng_state State of the random number generator, updated with each call
351+
* @param [in,out] rng_state State of the random number generator, updated with each call
352352
* @param [in] sampling_options
353353
* Opaque pointer defining the sampling options.
354354
* @param [in] do_expensive_check
@@ -599,7 +599,7 @@ cugraph_error_code_t cugraph_test_uniform_neighborhood_sample_result_create(
599599
*
600600
* @param [in] handle Handle for accessing resources
601601
* @param [in] graph Pointer to graph
602-
* @param [in/out] rng_state State of the random number generator, updated with each call
602+
* @param [in,out] rng_state State of the random number generator, updated with each call
603603
* @param [in] num_vertices Number of vertices to sample
604604
* @param [out] vertices Device array view to populate label
605605
* @param [out] error Pointer to an error object storing details of

cpp/include/cugraph_c/traversal_algorithms.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ void cugraph_paths_result_free(cugraph_paths_result_t* result);
8888
* @param [in] handle Handle for accessing resources
8989
* @param [in] graph Pointer to graph
9090
* FIXME: Make this just [in], copy it if I need to temporarily modify internally
91-
* @param [in/out] sources Array of source vertices. NOTE: Array might be modified if
91+
* @param [in,out] sources Array of source vertices. NOTE: Array might be modified if
9292
* renumbering is enabled for the graph
9393
* @param [in] direction_optimizing If set to true, this algorithm switches between the push based
9494
* breadth-first search and pull based breadth-first search depending on the size of the

0 commit comments

Comments
 (0)