diff mbox

[(alsa-lib)] pcm: Fix doxygen for two enums

Message ID 1440441449-6715-1-git-send-email-david.henningsson@canonical.com (mailing list archive)
State New, archived
Headers show

Commit Message

David Henningsson Aug. 24, 2015, 6:37 p.m. UTC 
The doxygen comments were wrong, making doxygen output weird.

Signed-off-by: David Henningsson <david.henningsson@canonical.com>
---
 include/pcm.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

Comments

Takashi Iwai Aug. 24, 2015, 8:27 p.m. UTC | #1 
On Mon, 24 Aug 2015 20:37:29 +0200,
David Henningsson wrote:
> 
> The doxygen comments were wrong, making doxygen output weird.
> 
> Signed-off-by: David Henningsson <david.henningsson@canonical.com>

Applied, thanks.


Takashi

> ---
>  include/pcm.h | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/include/pcm.h b/include/pcm.h
> index a1d14a9..0be1a32 100644
> --- a/include/pcm.h
> +++ b/include/pcm.h
> @@ -324,9 +324,9 @@ typedef enum _snd_pcm_tstamp {
>  } snd_pcm_tstamp_t;
>  
>  typedef enum _snd_pcm_tstamp_type {
> -	SND_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0,	/** gettimeofday equivalent */
> -	SND_PCM_TSTAMP_TYPE_MONOTONIC,	/** posix_clock_monotonic equivalent */
> -	SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW,	/** monotonic_raw (no NTP) */
> +	SND_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0,	/**< gettimeofday equivalent */
> +	SND_PCM_TSTAMP_TYPE_MONOTONIC,	/**< posix_clock_monotonic equivalent */
> +	SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW,	/**< monotonic_raw (no NTP) */
>  	SND_PCM_TSTAMP_TYPE_LAST = SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW,
>  } snd_pcm_tstamp_type_t;
>  
> @@ -527,11 +527,11 @@ int snd_pcm_unlink(snd_pcm_t *pcm);
>  
>  /** channel map list type */
>  enum snd_pcm_chmap_type {
> -	SND_CHMAP_TYPE_NONE = 0,/** unspecified channel position */
> -	SND_CHMAP_TYPE_FIXED,	/** fixed channel position */
> -	SND_CHMAP_TYPE_VAR,	/** freely swappable channel position */
> -	SND_CHMAP_TYPE_PAIRED,	/** pair-wise swappable channel position */
> -	SND_CHMAP_TYPE_LAST = SND_CHMAP_TYPE_PAIRED, /** last entry */
> +	SND_CHMAP_TYPE_NONE = 0,/**< unspecified channel position */
> +	SND_CHMAP_TYPE_FIXED,	/**< fixed channel position */
> +	SND_CHMAP_TYPE_VAR,	/**< freely swappable channel position */
> +	SND_CHMAP_TYPE_PAIRED,	/**< pair-wise swappable channel position */
> +	SND_CHMAP_TYPE_LAST = SND_CHMAP_TYPE_PAIRED, /**< last entry */
>  };
>  
>  /** channel positions */
> -- 
> 1.9.1
>
diff mbox

Patch

diff --git a/include/pcm.h b/include/pcm.h
index a1d14a9..0be1a32 100644
--- a/include/pcm.h
+++ b/include/pcm.h
@@ -324,9 +324,9 @@  typedef enum _snd_pcm_tstamp {
 } snd_pcm_tstamp_t;
 
 typedef enum _snd_pcm_tstamp_type {
-	SND_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0,	/** gettimeofday equivalent */
-	SND_PCM_TSTAMP_TYPE_MONOTONIC,	/** posix_clock_monotonic equivalent */
-	SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW,	/** monotonic_raw (no NTP) */
+	SND_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0,	/**< gettimeofday equivalent */
+	SND_PCM_TSTAMP_TYPE_MONOTONIC,	/**< posix_clock_monotonic equivalent */
+	SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW,	/**< monotonic_raw (no NTP) */
 	SND_PCM_TSTAMP_TYPE_LAST = SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW,
 } snd_pcm_tstamp_type_t;
 
@@ -527,11 +527,11 @@  int snd_pcm_unlink(snd_pcm_t *pcm);
 
 /** channel map list type */
 enum snd_pcm_chmap_type {
-	SND_CHMAP_TYPE_NONE = 0,/** unspecified channel position */
-	SND_CHMAP_TYPE_FIXED,	/** fixed channel position */
-	SND_CHMAP_TYPE_VAR,	/** freely swappable channel position */
-	SND_CHMAP_TYPE_PAIRED,	/** pair-wise swappable channel position */
-	SND_CHMAP_TYPE_LAST = SND_CHMAP_TYPE_PAIRED, /** last entry */
+	SND_CHMAP_TYPE_NONE = 0,/**< unspecified channel position */
+	SND_CHMAP_TYPE_FIXED,	/**< fixed channel position */
+	SND_CHMAP_TYPE_VAR,	/**< freely swappable channel position */
+	SND_CHMAP_TYPE_PAIRED,	/**< pair-wise swappable channel position */
+	SND_CHMAP_TYPE_LAST = SND_CHMAP_TYPE_PAIRED, /**< last entry */
 };
 
 /** channel positions */