From c74e0ea52f33e7ed9b9d7414e84490df26093345 Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Thu, 29 Nov 2018 10:25:04 +0100
Subject: [PATCH] Doxygen and RTD documentation fixes
---
README | 2 +-
doc/RTD/source/CommandLineOptions/index.rst | 4 ++++
examples/main.c | 2 +-
src/cell.c | 4 ++--
src/engine.c | 1 -
src/runner.c | 3 ---
6 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/README b/README
index 8462c9aead..bccc45e543 100644
--- a/README
+++ b/README
@@ -31,7 +31,7 @@ Valid options are:
-n {int} Execute a fixed number of time steps. When unset use the time_end parameter to stop.
-o {str} Generate a default output parameter file.
-P {sec:par:val} Set parameter value and overwrites values read from the parameters file. Can be used more than once.
- -r Continue using restart files.
+ -r Resume a run using restart files.
-s Run with hydrodynamics.
-S Run with stars.
-F Run with star formation.
diff --git a/doc/RTD/source/CommandLineOptions/index.rst b/doc/RTD/source/CommandLineOptions/index.rst
index a8ce7af082..e23eccd5bf 100644
--- a/doc/RTD/source/CommandLineOptions/index.rst
+++ b/doc/RTD/source/CommandLineOptions/index.rst
@@ -31,13 +31,17 @@ can be found by typing ``./swift -h``.
+ ``-o``: {str} Generate a default output parameter file.
+ ``-P``: {sec:par:val} Set parameter value and overwrites values read from the
parameters file. Can be used more than once.
++ ``-r``: Resume a run using restart files.
+ ``-s``: Run with hydrodynamics.
+ ``-S``: Run with stars.
++ ``-F``: Run with star formation.
++ ``-b``: Run with stars feedback.
+ ``-t``: {int} The number of threads to use on each MPI rank. Defaults to 1 if
not specified.
+ ``-T``: Print timers every time-step.
+ ``-v``: [12] Increase the level of verbosity: 1, MPI-rank 0 writes, 2, All
MPI-ranks write.
++ ``-x``: Run with structure finding.
+ ``-y``: {int} Time-step frequency at which task graphs are dumped.
+ ``-Y``: {int} Time-step frequency at which threadpool tasks are dumped.
+ ``-h``: Print a help message and exit.
diff --git a/examples/main.c b/examples/main.c
index 719a6a459d..4e0cc86f1d 100644
--- a/examples/main.c
+++ b/examples/main.c
@@ -95,7 +95,7 @@ void print_help_message(void) {
printf(" %2s %14s %s\n", "-P", "{sec:par:val}",
"Set parameter value and overwrites values read from the parameters "
"file. Can be used more than once.");
- printf(" %2s %14s %s\n", "-r", "", "Continue using restart files.");
+ printf(" %2s %14s %s\n", "-r", "", "Resume a run using restart files.");
printf(" %2s %14s %s\n", "-s", "", "Run with hydrodynamics.");
printf(" %2s %14s %s\n", "-S", "", "Run with stars.");
printf(" %2s %14s %s\n", "-F", "", "Run with star formation.");
diff --git a/src/cell.c b/src/cell.c
index 98d51b09fc..ed54163a00 100644
--- a/src/cell.c
+++ b/src/cell.c
@@ -3894,7 +3894,7 @@ void cell_recursively_shift_sparts(struct cell *c,
}
/**
- * @breif "Add" a #spart in a given #cell.
+ * @brief "Add" a #spart in a given #cell.
*
* This function will a a #spart at the start of the current cell's array by
* shifting all the #spart in the top-level cell by one position. All the
@@ -4176,7 +4176,7 @@ struct gpart *cell_convert_spart_to_gpart(const struct engine *e,
}
/**
- * @param "Remove" a #part from a #cell and replace it with a #spart
+ * @brief "Remove" a #part from a #cell and replace it with a #spart
* connected to the same #gpart.
*
* Note that the #part is not destroyed. The pointer is still valid
diff --git a/src/engine.c b/src/engine.c
index 59fb2faf98..09010fdc60 100644
--- a/src/engine.c
+++ b/src/engine.c
@@ -4002,7 +4002,6 @@ void engine_unpin(void) {
* @param potential The properties of the external potential.
* @param cooling_func The properties of the cooling function.
* @param chemistry The chemistry information.
- * @param sourceterms The properties of the source terms function.
*/
void engine_init(struct engine *e, struct space *s, struct swift_params *params,
long long Ngas, long long Ngparts, long long Nstars,
diff --git a/src/runner.c b/src/runner.c
index dd0e627ed1..dacefa498c 100644
--- a/src/runner.c
+++ b/src/runner.c
@@ -586,9 +586,6 @@ void runner_do_sort_ascending(struct entry *sort, int N) {
* @brief Recursively checks that the flags are consistent in a cell hierarchy.
*
* Debugging function. Exists in two flavours: hydro & stars.
- *
- * @param c The #cell to check.
- * @param flags The sorting flags to check.
*/
#define RUNNER_CHECK_SORTS(TYPE) \
void runner_check_sorts_##TYPE(struct cell *c, int flags) { \
--
GitLab