Regards #3: Doxygen comment corrections and some invalid comment text deletions

Author: eyalroz

examples/by_api_module/module_management.cpp

@@ -83,11 +83,6 @@ std::string make_instantiation_name(string_view base_name, Ts&&... args)
 	return sstr.str();
 }
 
-/**
- *
- * @param compilation_output
- * @param fine_day hello world
- */
 void handle_compilation_failure(
 	const cuda::rtc::compilation_output_t<cuda::cuda_cpp> & compilation_output,
 	const cuda::rtc::compilation_options_t<cuda::cuda_cpp> & compilation_options = {})

src/cuda/api/memory.hpp

@@ -757,7 +757,6 @@ inline void zero(void* ptr, size_t num_bytes, optional_ref<const stream_t> strea
  * @param ptr pointer to a single element of a certain type, which may
  * be in host-side memory, global CUDA-device-side memory or CUDA-managed
  * memory.
- * @param stream A stream on which to schedule this action; may be omitted.
  */
 template <typename T>
 inline void zero(T* ptr)
@@ -833,9 +832,8 @@ void copy(copy_parameters_t<NumDimensions> params, optional_ref<const stream_t>
  * @param destination A {@tparam NumDimensions}-dimensional CUDA array, including a specification
  *     of the context in which the array is defined.
  * @param source A pointer to a region of contiguous memory holding `destination.size()` values
- *     of type @tparam T. The memory may be located either on a CUDA device or in host memory.
- * @param context The context in which the source memory was allocated - possibly different than
- *     the target array context
+ *     of type {@tparam T}. The memory may be located either on a CUDA device or in host memory.
+ * @param stream A stream on which to schedule the copy action
  */
 template<typename T, dimensionality_t NumDimensions>
 void copy(const array_t<T, NumDimensions>& destination, const context_t& source_context, const T *source, optional_ref<const stream_t> stream = {})
@@ -858,14 +856,14 @@ void copy(const array_t<T, NumDimensions>& destination, const context_t& source_
  *
  * @param destination A {@tparam NumDimensions}-dimensional CUDA array
  * @param source A pointer to a region of contiguous memory holding `destination.size()` values
- * of type @tparam T. The memory may be located either on a CUDA device or in host memory.
+ * of type {@tparam T}. The memory may be located either on a CUDA device or in host memory.
  *
  * Asynchronously copies data into a CUDA array.
  *
  * @note asynchronous version of @ref memory::copy<T>(array_t<T, NumDimensions>&, const T*)
  *
  * @param destination A CUDA array to copy data into
- * @param source A pointer to a a memory region of size `destination.size() * sizeof(T)`
+ * @param source A pointer to a memory region of size `destination.size() * sizeof(T)`
  * @param stream schedule the copy operation into this CUDA stream
  */
 template <typename T, dimensionality_t NumDimensions>
@@ -899,7 +897,7 @@ void copy(const array_t<T, NumDimensions>& destination, span<T const> source, op
  * @tparam T array element type
  *
  * @param destination A pointer to a region of contiguous memory holding `destination.size()` values
- * of type @tparam T. The memory may be located either on a CUDA device or in host memory.
+ * of type {@tparam T}. The memory may be located either on a CUDA device or in host memory.
  * @param source A {@tparam NumDimensions}-dimensional CUDA array
  */
 template <typename T, dimensionality_t NumDimensions>
@@ -924,7 +922,7 @@ void copy(const context_t& context, T *destination, const array_t<T, NumDimensio
  * @tparam T array element type
  *
  * @param destination A pointer to a region of contiguous memory holding `destination.size()` values
- * of type @tparam T. The memory may be located either on a CUDA device or in host memory.
+ * of type {@tparam T}. The memory may be located either on a CUDA device or in host memory.
  * @param source A {@tparam NumDimensions}-dimensional CUDA array
  *
  * Asynchronously copies data from a CUDA array elsewhere
@@ -1829,7 +1827,7 @@ inline void set(region_t region, int byte_value)
 /**
  * Zero-out a region of host memory
  *
- * @param ptr the beginning of a region of host memory to zero-out
+ * @param start the beginning of a region of host memory to zero-out
  * @param num_bytes the size in bytes of the region of memory to zero-out
  */
 inline void zero(void* start, size_t num_bytes)
@@ -2361,12 +2359,11 @@ namespace detail_ {
  * @note We allow this only for "convenient" types; see @ref detail_check_allocation_type
  *
  * @tparam T Element of the created unique_span
- * @tparam UntypedAllocator can allocate untyped memory given a size
- * @tparam UntypedDeleter can delete memory given a pointer (disregarding the type)
+ * @tparam RegionAllocator can allocate untyped memory given a size
+ * @tparam RawDeleter can delete memory given a pointer (disregarding the type)
  *
  * @param size number of elements in the unique_span to be created
- * @param raw_allocator a gadget for allocating untyped memory
- * @param raw_deleter a gadget which can de-allocate/delete allocations by @p raw_allocator
+ * @param allocator a gadget for allocating untyped memory
  * @return the newly-created unique_span
  */
 template <typename T, typename RawDeleter, typename RegionAllocator>

src/cuda/api/multi_wrapper_impls/unique_region.hpp

@@ -76,10 +76,10 @@ namespace managed {
  * @brief Allocate a region of managed memory, accessible both from CUDA devices
  * and from the CPU.
  *
- * @param context A context of possible single-device-visibility
- *
  * @returns An owning RAII/CADRe object for the allocated managed memory region
  */
+///@{
+/// @param context A context of possible single-device-visibility
 inline unique_region make_unique_region(
 	const context_t&      context,
 	size_t                num_bytes,
@@ -89,14 +89,7 @@ inline unique_region make_unique_region(
 	return unique_region { detail_::allocate_in_current_context(num_bytes, initial_visibility) };
 }
 
-/**
- * @brief Allocate a region of managed memory, accessible both from CUDA devices
- * and from the CPU.
- *
- * @param context A context of possible single-device-visibility
- *
- * @returns An owning RAII/CADRe object for the allocated managed memory region
- */
+/// @param[in] device  whose primary context's memory the unique reqion is to be allocated in.
 inline unique_region make_unique_region(
 	const device_t&       device,
 	size_t                num_bytes,
@@ -106,6 +99,7 @@ inline unique_region make_unique_region(
 	return make_unique_region(pc, num_bytes, initial_visibility);
 }
 
+/// @note allocates the unique region on the (primary context of) the current device
 inline unique_region make_unique_region(
 	size_t                num_bytes,
 	initial_visibility_t  initial_visibility)
@@ -114,6 +108,7 @@ inline unique_region make_unique_region(
 	auto pc = cuda::device::primary_context::detail_::leaky_get(current_device_id);
 	return make_unique_region(pc, num_bytes, initial_visibility);
 }
+///@}
 
 } // namespace managed