format: Add periods to fix brief documentation for pa_format_info_is_pcm()

This commit is contained in:
Peter Meerwald 2011-12-12 13:19:44 +01:00 committed by Colin Guthrie
parent 66b2755361
commit 6e7e5d6fa0

View file

@ -77,7 +77,7 @@ typedef struct pa_format_info {
/** Allocates a new \a pa_format_info structure. Clients must initialise at least the encoding field themselves. */ /** Allocates a new \a pa_format_info structure. Clients must initialise at least the encoding field themselves. */
pa_format_info* pa_format_info_new(void); pa_format_info* pa_format_info_new(void);
/** Returns a new \a pa_format_info struct and representing the same format as \a src */ /** Returns a new \a pa_format_info struct and representing the same format as \a src. */
pa_format_info* pa_format_info_copy(const pa_format_info *src); pa_format_info* pa_format_info_copy(const pa_format_info *src);
/** Frees a \a pa_format_info structure */ /** Frees a \a pa_format_info structure */
@ -86,7 +86,7 @@ void pa_format_info_free(pa_format_info *f);
/** Returns non-zero when the format info structure is valid */ /** Returns non-zero when the format info structure is valid */
int pa_format_info_valid(const pa_format_info *f); int pa_format_info_valid(const pa_format_info *f);
/** Returns non-zero when the format info structure represents a PCM (i.e. uncompressed data) format */ /** Returns non-zero when the format info structure represents a PCM (i.e.\ uncompressed data) format. */
int pa_format_info_is_pcm(const pa_format_info *f); int pa_format_info_is_pcm(const pa_format_info *f);
/** Returns non-zero if the format represented by \a first is a subset of /** Returns non-zero if the format represented by \a first is a subset of