Commit 26ce9e56 authored by Quentin Khan's avatar Quentin Khan

Add break before '\brief' in FNode.hpp comments

parent 89e62b1a
......@@ -35,7 +35,8 @@ struct test_PostOrderNodeIterator;
namespace type_trait {
/** \brief Sink in type for SFINAE purpose
/**
* \brief Sink in type for SFINAE purpose
*
* Derives from std::true_type.
*
......@@ -44,13 +45,15 @@ namespace type_trait {
template<typename... Ts>
struct exist_t : std::true_type {};
/** \brief Compile check that `T::push(Args...)` exists
/**
* \brief Compile check that `T::push(Args...)` exists
*
* This does not check the return type
*/
template<typename T, typename... Args>
class has_push {
/** \brief Overload found if `T::push(Args...)` exists
/**
* \brief Overload found if `T::push(Args...)` exists
*
* If `T::push(Args...)` exists, this overload is found when
* computing #value at compile time.
......@@ -73,13 +76,15 @@ public:
};
/** \brief Compile check that `T::push_back(Args...)` exists
/**
* \brief Compile check that `T::push_back(Args...)` exists
*
* This does not check the return type
*/
template<typename T, typename... Args>
class has_push_back {
/** \brief Overload found if `T::push_back(Args...)` exists
/**
* \brief Overload found if `T::push_back(Args...)` exists
*
* If `T::push_back(Args...)` exists, this overload is found when
* computing #value at compile time.
......@@ -109,7 +114,8 @@ template<bool value, template<class...> class Checker, typename... Args>
using use_if = typename std::enable_if<value == Checker<Args...>::value >::type*;
/** \brief Exists (as void*) if T derives from Base
/**
* \brief Exists (as void*) if T derives from Base
*
* Type alias for use in SFINAE. Is a void* if Derived is derived from
* Base, does not exist otherwise.
......@@ -165,7 +171,8 @@ struct NodeEmptyData {};
/** \brief Tree node implementation
/**
* \brief Tree node implementation
*
*/
template<class _Tree, class _ParticleContainer, class NodeData>
......@@ -190,7 +197,8 @@ public:
using child_node_array_t = std::array<FNode*, child_count>;
/// Particle container type
using particle_container_t = _ParticleContainer;
/** \brief Particle type
/**
* \brief Particle type
* The particle must satisfy the following conditions:
* - Default constructible
* - Constructible from particle_container_t::value_type
......@@ -202,7 +210,8 @@ public:
using data_t = NodeData;
/** \brief Node structural data
/**
* \brief Node structural data
* Keeps data about the node that may be read by kernels or algorithms.
*/
......@@ -489,7 +498,8 @@ public:
}
private:
/** \brief Push particle in container if it has compatible 'push'
/**
* \brief Push particle in container if it has compatible 'push'
*
* \tparam T Container type
* \tparam scalfmm::sfinae::use_if SFINAE default argument. Compilation of
......@@ -504,7 +514,8 @@ private:
container.push(p);
}
/** \brief Push particle in container if it has compatible `push_back` and
/**
* \brief Push particle in container if it has compatible `push_back` and
* no `push`
*
* \tparam T Container type
......@@ -670,13 +681,15 @@ public:
private:
/** \brief Initialization of FNode cell data
/**
* \brief Initialization of FNode cell data
*
* Encloses the init functions that are used to initializes cell data
* according to their base class.
*/
struct cell_data_initializer {
/** \brief Initializer when CellData is derived from FBasicCell
/**
* \brief Initializer when CellData is derived from FBasicCell
*
* \tparam CellData Type of the node data
* \tparam Unnamed SFINAE type to check that CellData is derived from
......@@ -690,12 +703,14 @@ private:
data->setLevel(node->getDepth());
}
/** \brief Catch-all initializer, no-op */
/**
* \brief Catch-all initializer, no-op */
static void init(...) {}
};
/** \brief Common initialization done by constructors */
/**
* \brief Common initialization done by constructors */
void common_init() {
cell_data_initializer::init(this->getData(), this);
}
......@@ -845,7 +860,8 @@ private:
}
/** \brief Reinsert particles once children have been added
/**
* \brief Reinsert particles once children have been added
*
* The particle container is deleted afterwards.
*/
......
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