chiark / gitweb /
doxygen: clean up function documentation.
authorRichard Kettlewell <rjk@terraraq.org.uk>
Sun, 7 Aug 2011 13:10:31 +0000 (14:10 +0100)
committerRichard Kettlewell <rjk@terraraq.org.uk>
Sun, 7 Aug 2011 13:10:31 +0000 (14:10 +0100)
disobedience/playlists.c
disobedience/queue-generic.c
lib/resample.c

index c95db43..3b38bc7 100644 (file)
@@ -579,7 +579,7 @@ static const char *playlist_new_valid(void) {
 /** @brief Get entered new-playlist details
  * @param namep Where to store entered name (or NULL)
  * @param fullnamep Where to store computed full name (or NULL)
- * @param sharep Where to store 'shared' flag (or NULL)
+ * @param sharedp Where to store 'shared' flag (or NULL)
  * @param publicp Where to store 'public' flag (or NULL)
  * @param privatep Where to store 'private' flag (or NULL)
  */
@@ -663,7 +663,8 @@ static void playlist_picker_fill(const char attribute((unused)) *event,
 }
 
 /** @brief Update a section in the picker tree model
- * @param section Section name
+ * @param title Display name of section
+ * @param key Key to search for
  * @param start First entry in @ref playlists
  * @param end Past last entry in @ref playlists
  */
@@ -694,8 +695,7 @@ static void playlist_picker_update_section(const char *title, const char *key,
  * @param title Display name of section
  * @param key Key to search for
  * @param iter Iterator to point at key
- * @param create If TRUE, key will be created if it doesn't exist
- * @param compare Row comparison function
+ * @param create Whether to create the row
  * @return TRUE if key exists else FALSE
  *
  * If the @p key exists then @p iter will point to it and TRUE will be
index 333187a..a4cb793 100644 (file)
@@ -636,7 +636,7 @@ static void ql_drag_data_get_collect(GtkTreeModel *model,
  * @param w Source widget (the tree view)
  * @param dc Drag context
  * @param data Where to put the answer
- * @param info_ Target @c info parameter
+ * @param info Target @c info parameter
  * @param time_ Time data requested (for some reason not a @c time_t)
  * @param user_data The queuelike
  *
index 39514ed..bee3d95 100644 (file)
  * @param input_channels Number of input channels
  * @param input_signed Whether input samples are signed or unsigned
  * @param input_rate Frames/second in input
+ * @param input_endian Input endianness (@c ENDIAN_BIG or @c ENDIAN_LITTLE)
  * @param output_bits Bits/sample in output
  * @param output_channels Number of output channels
  * @param output_rate Frames/second in output
  * @param output_signed Whether output samples are signed or unsigned
+ * @param output_endian Output endianness (@c ENDIAN_BIG or @c ENDIAN_LITTLE)
  *
  * For formats with more than two channels it's assume that the first
  * two channels are left and right.  No particular meaning is attached
@@ -199,7 +201,7 @@ static size_t resample_put_sample(const struct resampler *rs,
 /** @brief Convert input samples to floats
  * @param rs Resampler state
  * @param bytes Input bytes
- * @param nbytes Number of input bytes
+ * @param nframes Number of input frames
  * @param floats Where to store converted data
  *
  * @p floats must be big enough.  As well as converting to floats this