Unverified Commit 619d735d authored by Hongzhi (Steve), Chen's avatar Hongzhi (Steve), Chen Committed by GitHub
Browse files

[Misc] Replace \xxx with @XXX in structured comment. (#4822)



* param

* brief

* note

* return

* tparam

* brief2

* file

* return2

* return

* blabla

* all
Co-authored-by: default avatarSteve <ubuntu@ip-172-31-34-29.ap-northeast-1.compute.internal>
parent 96297fb8
/*!
* Copyright (c) 2019 by Contributors
* \file array/cpu/array_index_select.cc
* \brief Array index select CPU implementation
* @file array/cpu/array_index_select.cc
* @brief Array index select CPU implementation
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/array_nonzero.cc
* \brief Array nonzero CPU implementation
* @file array/cpu/array_nonzero.cc
* @brief Array nonzero CPU implementation
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2019 by Contributors
* \file array/cpu/array_op_impl.cc
* \brief Array operator CPU implementation
* @file array/cpu/array_op_impl.cc
* @brief Array operator CPU implementation
*/
#include <dgl/array.h>
#include <dgl/runtime/ndarray.h>
......
/*!
* Copyright (c) 2019 by Contributors
* \file array/cpu/array_index_select.cc
* \brief Array index select CPU implementation
* @file array/cpu/array_index_select.cc
* @brief Array index select CPU implementation
*/
#include <dgl/array.h>
#include <dgl/runtime/parallel_for.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/array_repeat.cc
* \brief Array repeat CPU implementation
* @file array/cpu/array_repeat.cc
* @brief Array repeat CPU implementation
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2019 by Contributors
* \file array/cpu/array_scatter.cc
* \brief Array scatter CPU implementation
* @file array/cpu/array_scatter.cc
* @brief Array scatter CPU implementation
*/
#include <dgl/array.h>
#include <dgl/runtime/parallel_for.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/array_sort.cc
* \brief Array sort CPU implementation
* @file array/cpu/array_sort.cc
* @brief Array sort CPU implementation
*/
#include <dgl/array.h>
#ifdef PARALLEL_ALGORITHMS
......
/*!
* Copyright (c) 2019 by Contributors
* \file dgl/array_utils.h
* \brief Utility classes and functions for DGL arrays.
* @file dgl/array_utils.h
* @brief Utility classes and functions for DGL arrays.
*/
#ifndef DGL_ARRAY_CPU_ARRAY_UTILS_H_
#define DGL_ARRAY_CPU_ARRAY_UTILS_H_
......@@ -19,7 +19,7 @@ namespace dgl {
namespace aten {
/*!
* \brief A hashmap that maps each ids in the given array to new ids starting
* @brief A hashmap that maps each ids in the given array to new ids starting
* from zero.
*
* Useful for relabeling integers and finding unique integers.
......@@ -110,7 +110,7 @@ class IdHashMap {
};
/*
* \brief Hash type for building maps/sets with pairs as keys.
* @brief Hash type for building maps/sets with pairs as keys.
*/
struct PairHash {
template <class T1, class T2>
......
/*!
* Copyright (c) 2019 by Contributors
* \file array/cpu/coo_coalesce.cc
* \brief COO coalescing
* @file array/cpu/coo_coalesce.cc
* @brief COO coalescing
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/coo_line_graph.cc
* \brief COO LineGraph
* @file array/cpu/coo_line_graph.cc
* @brief COO LineGraph
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/coo_remove.cc
* \brief COO matrix remove entries CPU implementation
* @file array/cpu/coo_remove.cc
* @brief COO matrix remove entries CPU implementation
*/
#include <dgl/array.h>
......@@ -17,7 +17,7 @@ namespace impl {
namespace {
/*! \brief COORemove implementation for COOMatrix with default consecutive edge
/*! @brief COORemove implementation for COOMatrix with default consecutive edge
* IDs */
template <DGLDeviceType XPU, typename IdType>
void COORemoveConsecutive(
......@@ -45,7 +45,7 @@ void COORemoveConsecutive(
}
}
/*! \brief COORemove implementation for COOMatrix with shuffled edge IDs */
/*! @brief COORemove implementation for COOMatrix with shuffled edge IDs */
template <DGLDeviceType XPU, typename IdType>
void COORemoveShuffled(
COOMatrix coo, IdArray entries, std::vector<IdType> *new_rows,
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/coo_sort.cc
* \brief COO sorting
* @file array/cpu/coo_sort.cc
* @brief COO sorting
*/
#include <dgl/array.h>
#ifdef PARALLEL_ALGORITHMS
......
/*!
* Copyright (c) 2021 by Contributors
* \file array/cpu/csr_get_data.cc
* \brief Retrieve entries of a CSR matrix
* @file array/cpu/csr_get_data.cc
* @brief Retrieve entries of a CSR matrix
*/
#include <dgl/array.h>
#include <dgl/runtime/parallel_for.h>
......
/*!
* Copyright (c) 2019 by Contributors
* \file array/cpu/csr_mm.cc
* \brief CSR Matrix Multiplication
* @file array/cpu/csr_mm.cc
* @brief CSR Matrix Multiplication
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/coo_remove.cc
* \brief CSR matrix remove entries CPU implementation
* @file array/cpu/coo_remove.cc
* @brief CSR matrix remove entries CPU implementation
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/csr_sort.cc
* \brief CSR sorting
* @file array/cpu/csr_sort.cc
* @brief CSR sorting
*/
#include <dgl/array.h>
#include <dgl/runtime/parallel_for.h>
......
/*!
* Copyright (c) 2019 by Contributors
* \file array/cpu/csr_sum.cc
* \brief CSR Summation
* @file array/cpu/csr_sum.cc
* @brief CSR Summation
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/csr_to_simple.cc
* \brief CSR sorting
* @file array/cpu/csr_to_simple.cc
* @brief CSR sorting
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/coo_sort.cc
* \brief COO sorting
* @file array/cpu/coo_sort.cc
* @brief COO sorting
*/
#include <dgl/array.h>
#include <dgl/runtime/parallel_for.h>
......
......@@ -13,8 +13,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
* \file array/cpu/disjoint_union.cc
* \brief Disjoint union CPU implementation.
* @file array/cpu/disjoint_union.cc
* @brief Disjoint union CPU implementation.
*/
#include <dgl/array.h>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment