Documentation fixes.

src/runner_doiact_stars.h

@@ -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
  *
  * @param r runner task
- * @param c cell
- * @param timer 1 if the time is to be recorded.
+ * @param ci The first #cell
+ * @param cj The second #cell
  */
 void runner_dosubpair_stars_density(struct runner *r, struct cell *restrict ci,
                                     struct cell *restrict cj) {
@@ -324,7 +324,7 @@ void runner_doself_subset_stars_density(struct runner *r,
 
 * @param r The #runner.
 * @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 scount The number of particles in @c ind.
 */

src/scheduler.c

@@ -116,17 +116,18 @@ void scheduler_addunlock(struct scheduler *s, struct task *ta,
 /**
  * @brief generate the dependency name for the tasks
  *
- * @param ta The #task
- * @param ta_name The formatted string
+ * @param ta_type The #task type.
+ * @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) {
 
   /* Check input */
-  if (ta_type < 0 || ta_type >= task_type_count)
-    error("Unknown task type %i", ta_type);
+  if (ta_type >= task_type_count) 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,
           taskID_names[ta_type]);
 

src/stars/Default/stars.h

@@ -97,6 +97,7 @@ __attribute__((always_inline)) INLINE static void stars_kick_extra(
  * @brief Finishes the calculation of density on stars
  *
  * @param sp The particle to act upon
+ * @param cosmo The current cosmological model.
  */
 __attribute__((always_inline)) INLINE static void stars_end_density(
     struct spart* sp, const struct cosmology* cosmo) {

src/stars/Default/stars_io.h

@@ -81,10 +81,11 @@ INLINE static void stars_write_particles(const struct spart *sparts,
  *
  * 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 us The internal unit system.
  * @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,
                                     const struct phys_const *phys_const,
@@ -126,7 +127,7 @@ INLINE static void stars_props_init(struct stars_props *sp,
 /**
  * @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) {
 

src/task.c

@@ -73,10 +73,9 @@ MPI_Comm subtaskMPI_comms[task_subtype_count];
 /**
  * @brief Computes the overlap between the parts array of two given cells.
  *
- * TYPE is the type of parts (e.g. #part, #gpart, #spart)
- *
- * @param ci The first #cell.
- * @param cj The second #cell.
+ * @param TYPE is the type of parts (e.g. #part, #gpart, #spart)
+ * @param ARRAY is the array of this specific type.
+ * @param COUNT is the number of elements in the array.
  */
 #define TASK_CELL_OVERLAP(TYPE, ARRAY, COUNT)                               \
   __attribute__((always_inline))                                            \

tests/test27cellsStars.c

@@ -53,12 +53,13 @@
  * a DOPAIR or DOSELF calcuation.
  *
  * @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 size The cell size.
  * @param h The smoothing length of the particles in units of the inter-particle
  * 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
  * of the inter-particle separation.
  * @param h_pert The perturbation to apply to the smoothing length.