Skip to content

Commit eb45c5d

Browse files
committed
Fix Doxygen documentation warnings.
1 parent 0ae874f commit eb45c5d

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

docs/resources/dirs.dox

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@
400400
* @dir include/plssvm/backends/HPX/detail
401401
* @author Alexander Van Craen
402402
* @author Marcel Breyer
403-
* @authir Alexander Strack
403+
* @author Alexander Strack
404404
* @copyright 2018-today The PLSSVM project - All Rights Reserved
405405
* @license This file is part of the PLSSVM project which is released under the MIT license.
406406
* See the LICENSE.md file in the project root for full license information.
@@ -436,7 +436,7 @@
436436
* @dir include/plssvm/backends/HPX/kernel/cg_implicit
437437
* @author Alexander Van Craen
438438
* @author Marcel Breyer
439-
* @author Alexander Strack
439+
* @author Alexander Strack
440440
* @copyright 2018-today The PLSSVM project - All Rights Reserved
441441
* @license This file is part of the PLSSVM project which is released under the MIT license.
442442
* See the LICENSE.md file in the project root for full license information.

include/plssvm/backends/Kokkos/detail/constexpr_available_execution_spaces.hpp

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@
1313
#ifndef PLSSVM_BACKENDS_KOKKOS_DETAIL_CONSTEXPR_AVAILABLE_EXECUTION_SPACES_HPP_
1414
#define PLSSVM_BACKENDS_KOKKOS_DETAIL_CONSTEXPR_AVAILABLE_EXECUTION_SPACES_HPP_
1515

16-
// if the variable isn't set, no Kokkos execution space is available
17-
// -> explicitly set it to 0!
16+
/**
17+
* @def PLSSVM_KOKKOS_BACKEND_NUM_AVAILABLE_EXECUTION_SPACES
18+
* @brief Set the macro `PLSSVM_KOKKOS_BACKEND_NUM_AVAILABLE_EXECUTION_SPACES` to 0 if it isn't already defined, i.e., no Kokkos execution space is available.
19+
* Will normally be propagated by CMake with the number of available Kokkos execution spaces.
20+
*/
1821
#if !defined(PLSSVM_KOKKOS_BACKEND_NUM_AVAILABLE_EXECUTION_SPACES)
1922
#define PLSSVM_KOKKOS_BACKEND_NUM_AVAILABLE_EXECUTION_SPACES 0
2023
#endif

include/plssvm/environment.hpp

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,8 @@ inline std::vector<backend_type> finalize() {
458458
class [[nodiscard]] scope_guard {
459459
public:
460460
/**
461-
* @copydoc initialize()
461+
* @brief Initialize all **available** backends.
462+
* @details Only initializes backends that are currently uninitialized.
462463
*/
463464
scope_guard() {
464465
backends_ = initialize();
@@ -473,7 +474,10 @@ class [[nodiscard]] scope_guard {
473474
}
474475

475476
/**
476-
* @copydoc initialize(int &, char **)
477+
* @brief Initialize all **available** backends.
478+
* @details Only initializes backends that are currently uninitialized.
479+
* @param[in,out] argc the number of provided command line arguments
480+
* @param[in,out] argv the provided command line arguments
477481
*/
478482
scope_guard(int &argc, char **argv) {
479483
backends_ = initialize(argc, argv);

0 commit comments

Comments
 (0)