Commit eec297e5 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Documentation fixes.

parent 9079ffb3
...@@ -89,8 +89,8 @@ void runner_doself_stars_density(struct runner *r, struct cell *c, int timer) { ...@@ -89,8 +89,8 @@ void runner_doself_stars_density(struct runner *r, struct cell *c, int timer) {
* @brief Calculate the number density of cj #part around the ci #spart * @brief Calculate the number density of cj #part around the ci #spart
* *
* @param r runner task * @param r runner task
* @param c cell * @param ci The first #cell
* @param timer 1 if the time is to be recorded. * @param cj The second #cell
*/ */
void runner_dosubpair_stars_density(struct runner *r, struct cell *restrict ci, void runner_dosubpair_stars_density(struct runner *r, struct cell *restrict ci,
struct cell *restrict cj) { struct cell *restrict cj) {
...@@ -324,7 +324,7 @@ void runner_doself_subset_stars_density(struct runner *r, ...@@ -324,7 +324,7 @@ void runner_doself_subset_stars_density(struct runner *r,
* @param r The #runner. * @param r The #runner.
* @param ci The first #cell. * @param ci The first #cell.
* @param parts The #spart to interact. * @param sparts The #spart to interact.
* @param ind The list of indices of particles in @c ci to interact with. * @param ind The list of indices of particles in @c ci to interact with.
* @param scount The number of particles in @c ind. * @param scount The number of particles in @c ind.
*/ */
......
...@@ -116,17 +116,18 @@ void scheduler_addunlock(struct scheduler *s, struct task *ta, ...@@ -116,17 +116,18 @@ void scheduler_addunlock(struct scheduler *s, struct task *ta,
/** /**
* @brief generate the dependency name for the tasks * @brief generate the dependency name for the tasks
* *
* @param ta The #task * @param ta_type The #task type.
* @param ta_name The formatted string * @param ta_subtype The #task type.
* @param ta_name (return) The formatted string
*/ */
void scheduler_task_dependency_name(int ta_type, int ta_subtype, void scheduler_task_dependency_name(enum task_types ta_type,
enum task_subtypes ta_subtype,
char *ta_name) { char *ta_name) {
/* Check input */ /* Check input */
if (ta_type < 0 || ta_type >= task_type_count) if (ta_type >= task_type_count) error("Unknown task type %i", ta_type);
error("Unknown task type %i", ta_type);
if (ta_subtype < 0 || ta_subtype >= task_subtype_count) if (ta_subtype >= task_subtype_count)
error("Unknown task subtype %i with type %s", ta_subtype, error("Unknown task subtype %i with type %s", ta_subtype,
taskID_names[ta_type]); taskID_names[ta_type]);
......
...@@ -97,6 +97,7 @@ __attribute__((always_inline)) INLINE static void stars_kick_extra( ...@@ -97,6 +97,7 @@ __attribute__((always_inline)) INLINE static void stars_kick_extra(
* @brief Finishes the calculation of density on stars * @brief Finishes the calculation of density on stars
* *
* @param sp The particle to act upon * @param sp The particle to act upon
* @param cosmo The current cosmological model.
*/ */
__attribute__((always_inline)) INLINE static void stars_end_density( __attribute__((always_inline)) INLINE static void stars_end_density(
struct spart* sp, const struct cosmology* cosmo) { struct spart* sp, const struct cosmology* cosmo) {
......
...@@ -81,10 +81,11 @@ INLINE static void stars_write_particles(const struct spart *sparts, ...@@ -81,10 +81,11 @@ INLINE static void stars_write_particles(const struct spart *sparts,
* *
* By default, takes the values provided by the hydro. * By default, takes the values provided by the hydro.
* *
* @param p The #stars_props. * @param sp The #stars_props.
* @param phys_const The physical constants in the internal unit system. * @param phys_const The physical constants in the internal unit system.
* @param us The internal unit system. * @param us The internal unit system.
* @param params The parsed parameters. * @param params The parsed parameters.
* @param p The already read-in properties of the hydro scheme.
*/ */
INLINE static void stars_props_init(struct stars_props *sp, INLINE static void stars_props_init(struct stars_props *sp,
const struct phys_const *phys_const, const struct phys_const *phys_const,
...@@ -126,7 +127,7 @@ INLINE static void stars_props_init(struct stars_props *sp, ...@@ -126,7 +127,7 @@ INLINE static void stars_props_init(struct stars_props *sp,
/** /**
* @brief Print the global properties of the stars scheme. * @brief Print the global properties of the stars scheme.
* *
* @param p The #stars_props. * @param sp The #stars_props.
*/ */
INLINE static void stars_props_print(const struct stars_props *sp) { INLINE static void stars_props_print(const struct stars_props *sp) {
......
...@@ -73,10 +73,9 @@ MPI_Comm subtaskMPI_comms[task_subtype_count]; ...@@ -73,10 +73,9 @@ MPI_Comm subtaskMPI_comms[task_subtype_count];
/** /**
* @brief Computes the overlap between the parts array of two given cells. * @brief Computes the overlap between the parts array of two given cells.
* *
* TYPE is the type of parts (e.g. #part, #gpart, #spart) * @param TYPE is the type of parts (e.g. #part, #gpart, #spart)
* * @param ARRAY is the array of this specific type.
* @param ci The first #cell. * @param COUNT is the number of elements in the array.
* @param cj The second #cell.
*/ */
#define TASK_CELL_OVERLAP(TYPE, ARRAY, COUNT) \ #define TASK_CELL_OVERLAP(TYPE, ARRAY, COUNT) \
__attribute__((always_inline)) \ __attribute__((always_inline)) \
......
...@@ -53,12 +53,13 @@ ...@@ -53,12 +53,13 @@
* a DOPAIR or DOSELF calcuation. * a DOPAIR or DOSELF calcuation.
* *
* @param n The cube root of the number of particles. * @param n The cube root of the number of particles.
* @param n The cube root of the number of star particles. * @param n_stars The cube root of the number of star particles.
* @param offset The position of the cell offset from (0,0,0). * @param offset The position of the cell offset from (0,0,0).
* @param size The cell size. * @param size The cell size.
* @param h The smoothing length of the particles in units of the inter-particle * @param h The smoothing length of the particles in units of the inter-particle
* separation. * separation.
* @param partId The running counter of IDs. * @param partId The running counter of IDs for gas.
* @param spartId The running counter of IDs for stars.
* @param pert The perturbation to apply to the particles in the cell in units * @param pert The perturbation to apply to the particles in the cell in units
* of the inter-particle separation. * of the inter-particle separation.
* @param h_pert The perturbation to apply to the smoothing length. * @param h_pert The perturbation to apply to the smoothing length.
......
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