[alsa-devel] [PATCH 1/3] ucm: docs: fix doxygen exclude patch for UCM local header
Signed-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com --- doc/doxygen.cfg.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in index f4499d6..043e75b 100644 --- a/doc/doxygen.cfg.in +++ b/doc/doxygen.cfg.in @@ -94,7 +94,7 @@ EXCLUDE = @top_srcdir@/src/control/control_local.h \ @top_srcdir@/src/mixer/mixer_local.h \ @top_srcdir@/src/rawmidi/rawmidi_local.h \ @top_srcdir@/src/seq/seq_local.h \ - @top_srcdir@/src/seq/ucm_local.h + @top_srcdir@/src/ucm/ucm_local.h RECURSIVE = YES FILE_PATTERNS = *.c *.h EXAMPLE_PATH = @top_srcdir@/test
Make sure group is defined and lists dipplayed correctly.
Signed-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com --- include/use-case.h | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-)
diff --git a/include/use-case.h b/include/use-case.h index c7789c0..9aac6e2 100644 --- a/include/use-case.h +++ b/include/use-case.h @@ -43,15 +43,13 @@ extern "C" { #endif
/** - * \defgroup Use Case Interface + * \defgroup ucm Use Case Interface * The ALSA Use Case manager interface. * See \ref Usecase page for more details. * { */
/*! \page Usecase ALSA Use Case Interface - * - * ALSA Use Case Interface * * The use case manager works by configuring the sound card ALSA kcontrols to * change the hardware digital and analog audio routing to match the requested @@ -69,9 +67,9 @@ extern "C" { * * However there are times when a use case has to be modified at runtime. e.g. * - * o Incoming phone call when the device is playing music - * o Recording sections of a phone call - * o Playing tones during a call. + * + Incoming phone call when the device is playing music + * + Recording sections of a phone call + * + Playing tones during a call. * * In order to allow asynchronous runtime use case adaptations, we have a third * optional modifier parameter that can be used to further configure @@ -79,13 +77,13 @@ extern "C" { * * This interface allows clients to :- * - * o Query the supported use case verbs, devices and modifiers for the machine. - * o Set and Get use case verbs, devices and modifiers for the machine. - * o Get the ALSA PCM playback and capture device PCMs for use case verb, + * + Query the supported use case verbs, devices and modifiers for the machine. + * + Set and Get use case verbs, devices and modifiers for the machine. + * + Get the ALSA PCM playback and capture device PCMs for use case verb, * use case device and modifier. - * o Get the TQ parameter for each use case verb, use case device and + * + Get the TQ parameter for each use case verb, use case device and * modifier. - * o Get the ALSA master playback and capture volume/switch kcontrols + * + Get the ALSA master playback and capture volume/switch kcontrols * for each use case. */
Signed-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com --- doc/index.doxygen | 1 + 1 file changed, 1 insertion(+)
diff --git a/doc/index.doxygen b/doc/index.doxygen index 45aa68a..7d049fe 100644 --- a/doc/index.doxygen +++ b/doc/index.doxygen @@ -40,6 +40,7 @@ may be placed in the library code instead of the kernel driver.</P> <LI>Page \ref rawmidi explains the design of the RawMidi API. <LI>Page \ref timer explains the design of the Timer API. <LI>Page \ref seq explains the design of the Sequencer API. + <LI>Page \ref ucm explains the use case API. </UL>
<H2>Configuration</H2>
At Mon, 29 Jun 2015 16:25:57 +0100, Liam Girdwood wrote:
Signed-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com
Thanks, applied all three patches. (The next would be to fix doxygen warnings :)
Takashi
doc/doxygen.cfg.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in index f4499d6..043e75b 100644 --- a/doc/doxygen.cfg.in +++ b/doc/doxygen.cfg.in @@ -94,7 +94,7 @@ EXCLUDE = @top_srcdir@/src/control/control_local.h \ @top_srcdir@/src/mixer/mixer_local.h \ @top_srcdir@/src/rawmidi/rawmidi_local.h \ @top_srcdir@/src/seq/seq_local.h \
@top_srcdir@/src/seq/ucm_local.h
@top_srcdir@/src/ucm/ucm_local.h
RECURSIVE = YES FILE_PATTERNS = *.c *.h EXAMPLE_PATH = @top_srcdir@/test -- 2.1.4
On Mon, 2015-06-29 at 17:45 +0200, Takashi Iwai wrote:
At Mon, 29 Jun 2015 16:25:57 +0100, Liam Girdwood wrote:
Signed-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com
Thanks, applied all three patches. (The next would be to fix doxygen warnings :)
The number is somewhat reduced now that the correct exclude path is used for ucm :) Most are in PCM now.
Liam
participants (2)
-
Liam Girdwood
-
Takashi Iwai