Commit 4b47fd6c authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Updated the Doxyfile and corrected the doxygen documentation tags that raised...

Updated the Doxyfile and corrected the doxygen documentation tags that raised warnings. Build is now cleaner.


Former-commit-id: 5ca3a6d2612545e910dc0a74f3df5ed043c05ee9
parent 3b09f3ec
This diff is collapsed.
......@@ -273,7 +273,7 @@ void engine_redistribute ( struct engine *e ) {
/**
* @breif Repartition the cells amongst the nodes.
* @brief Repartition the cells amongst the nodes.
*
* @param e The #engine.
*/
......@@ -582,9 +582,8 @@ void engine_addtasks_grav ( struct engine *e , struct cell *c , struct task *up
* @brief Add send tasks to a hierarchy of cells.
*
* @param e The #engine.
* @param c The #cell.
* @param t_xv The send_xv #task, if it has already been created.
* @param t_rho The send_rho #task, if it has already been created.
* @param ci The sending #cell.
* @param cj The receiving #cell
*/
void engine_addtasks_send ( struct engine *e , struct cell *ci , struct cell *cj ) {
......@@ -906,7 +905,7 @@ int engine_exchange_strays ( struct engine *e , struct part *parts , struct xpar
/**
* @brief Fill the #space's task list.
*
* @param s The #space we are working in.
* @param e The #engine we are working with.
*/
void engine_maketasks ( struct engine *e ) {
......@@ -1414,6 +1413,7 @@ void engine_prepare ( struct engine *e ) {
* @brief Implements a barrier for the #runner threads.
*
* @param e The #engine.
* @param tid The thread ID
*/
void engine_barrier ( struct engine *e , int tid ) {
......@@ -1602,11 +1602,11 @@ void engine_collect_kick2 ( struct cell *c ) {
/**
* @breif Launch the runners.
* @brief Launch the runners.
*
* @param e The #engine.
* @param nr_runners The number of #runners to let loose.
* @param The task mask to launch.
* @param nr_runners The number of #runner to let loose.
* @param mask The task mask to launch.
*/
void engine_launch ( struct engine *e , int nr_runners , unsigned int mask ) {
......@@ -1656,7 +1656,6 @@ void hassorted ( struct cell *c ) {
* @brief Let the #engine loose to compute the forces.
*
* @param e The #engine.
* @param sort_queues Flag to try to sort the queues topologically.
*/
void engine_step ( struct engine *e ) {
......@@ -1995,6 +1994,8 @@ void engine_split ( struct engine *e , int *grid ) {
* @param dt The initial time step to use.
* @param nr_threads The number of threads to spawn.
* @param nr_queues The number of task queues to create.
* @param nr_nodes The number of MPI ranks
* @param nodeID The MPI rank of this node
* @param policy The queueing policy to use.
*/
......
......@@ -58,7 +58,7 @@
/**
* @brief Exchange cells with a remote node.
*
* @paam p The #proxy.
* @param p The #proxy.
*/
void proxy_cells_exch1 ( struct proxy *p ) {
......@@ -197,7 +197,7 @@ void proxy_addcell_out ( struct proxy *p , struct cell *c ) {
/**
* @brief Exchange particles with a remote node.
*
* @paam p The #proxy.
* @param p The #proxy.
*/
void proxy_parts_exch1 ( struct proxy *p ) {
......@@ -304,6 +304,7 @@ void proxy_parts_load ( struct proxy *p , struct part *parts , struct xpart *xpa
* @brief Initialize the given proxy.
*
* @param p The #proxy.
* @param mynodeID The node this proxy is running on.
* @param nodeID The node with which this proxy will communicate.
*/
......
......@@ -118,7 +118,6 @@ void queue_insert ( struct queue *q , struct task *t ) {
* @brief Initialize the given queue.
*
* @param q The #queue.
* @param size The maximum size of the queue.
* @param tasks List of tasks to which the queue indices refer to.
*/
......@@ -146,8 +145,8 @@ void queue_init ( struct queue *q , struct task *tasks ) {
* @brief Get a task free of dependencies and conflicts.
*
* @param q The task #queue.
* @param super The super-cell tat might conflict with the #queue
* @param blocking Block until access to the queue is granted.
* @param keep Remove the returned task from this queue.
*/
struct task *queue_gettask ( struct queue *q , struct cell *super , int blocking ) {
......
......@@ -107,7 +107,7 @@ const char runner_flip[27] = { 1 , 1 , 1 , 1 , 1 , 1 , 1 , 1 , 1 , 1 , 1 , 1 , 1
* @param r The #runner.
* @param c The #cell.
* @param nodeID The destination node's ID.
* @param tagbit bit to distinguish between xv and rho sends.
* @param tag bit to distinguish between xv and rho sends.
*/
void runner_dosend ( struct runner *r , struct cell *c , int nodeID , int tag ) {
......@@ -1025,6 +1025,7 @@ void runner_dokick1 ( struct runner *r , struct cell *c ) {
*
* @param r The runner thread.
* @param c The cell.
* @param timer The timer
*/
void runner_dokick ( struct runner *r , struct cell *c , int timer ) {
......
......@@ -1795,7 +1795,8 @@ void DOSELF2 ( struct runner *r , struct cell *restrict c ) {
* @param r The #runner.
* @param ci The first #cell.
* @param cj The second #cell.
* @param sid
* @param sid The direction linking the cells
* @param gettimer Do we have a timer ?
*
* @todo Hard-code the sid on the recursive calls to avoid the
* redundant computations to find the sid on-the-fly.
......
......@@ -1053,6 +1053,7 @@ struct task *scheduler_unlock ( struct scheduler *s , struct task *t ) {
*
* @param s The #scheduler.
* @param qid The ID of the prefered #queue.
* @param super the super-cell
*
* @return A pointer to a #task or @c NULL if there are no available tasks.
*/
......@@ -1134,8 +1135,10 @@ struct task *scheduler_gettask ( struct scheduler *s , int qid , struct cell *su
* @brief Initialize the #scheduler.
*
* @param s The #scheduler.
* @param space The #space we are working with
* @param nr_queues The number of queues in this scheduler.
* @param flags The #scheduler flags.
* @param nodeID The MPI rank
*/
void scheduler_init ( struct scheduler *s , struct space *space , int nr_queues , unsigned int flags , int nodeID ) {
......
......@@ -467,6 +467,7 @@ void space_rebuild ( struct space *s , double cell_max ) {
* @brief Sort the particles and condensed particles according to the given indices.
*
* @param parts The list of #part
* @param xparts The list of reduced particles
* @param ind The indices with respect to which the parts are sorted.
* @param N The number of parts
* @param min Lowest index.
......@@ -1140,7 +1141,7 @@ struct cell *space_getcell ( struct space *s ) {
* @param h_max The maximal interaction radius.
*
* Makes a grid of edge length > r_max and fills the particles
* into the respective cells. Cells containing more than #space_maxppc
* into the respective cells. Cells containing more than #space_splitsize
* parts with a cutoff below half the cell width are then split
* recursively.
*/
......
......@@ -21,7 +21,7 @@
#define SWIFT_VERSION_H
/**
* @file version.h.in
* @file version.h
* @brief Package version and git revision sha.
*/
......
Supports Markdown
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