channelmap, volume: Don't refer to bool in the public API documentation
authorTanu Kaskinen <tanu.kaskinen@linux.intel.com>
Thu, 4 Jul 2013 09:20:15 +0000 (12:20 +0300)
committerTanu Kaskinen <tanu.kaskinen@linux.intel.com>
Thu, 4 Jul 2013 09:35:55 +0000 (12:35 +0300)
src/pulse/channelmap.h
src/pulse/volume.h

index da46556..47d2514 100644 (file)
@@ -351,7 +351,7 @@ mapping, i.e.\ "Stereo", "Surround 7.1" and so on. If the channel
 mapping is unknown NULL will be returned. \since 0.9.15 */
 const char* pa_channel_map_to_pretty_name(const pa_channel_map *map) PA_GCC_PURE;
 
-/** Returns true if the specified channel position is available at
+/** Returns non-zero if the specified channel position is available at
  * least once in the channel map. \since 0.9.16 */
 int pa_channel_map_has_position(const pa_channel_map *map, pa_channel_position_t p) PA_GCC_PURE;
 
index fa952c6..1e1beb4 100644 (file)
@@ -224,7 +224,7 @@ pa_volume_t pa_cvolume_min(const pa_cvolume *a) PA_GCC_PURE;
  * \since 0.9.16 */
 pa_volume_t pa_cvolume_min_mask(const pa_cvolume *a, const pa_channel_map *cm, pa_channel_position_mask_t mask) PA_GCC_PURE;
 
-/** Return true when the passed cvolume structure is valid, false otherwise */
+/** Return non-zero when the passed cvolume structure is valid */
 int pa_cvolume_valid(const pa_cvolume *v) PA_GCC_PURE;
 
 /** Return non-zero if the volume of all channels is equal to the specified value */