ucm: docs: fix doxygen exclude patch for UCM local header
PATCH 1/3 ucm: docs: fix doxygen exclude patch for UCM local header
Signed-off-by Liam Girdwood <[email protected]>
--- doc/doxygen.cfg.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
doc/doxygen.cfg.in +1 -1
@@ -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
Signature · 1 line
2.1.4
PATCH 2/3 ucm: docs: Fix doxygen formatting for UCM main page.
Make sure group is defined and lists dipplayed correctly.
Signed-off-by Liam Girdwood <[email protected]>
--- include/use-case.h | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-)
include/use-case.h +9 -11
@@ -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. */
Signature · 1 line
2.1.4
PATCH 3/3 docs: Add UCM link to main doxygen page.
In reply to Liam GirdwoodSigned-off-by Liam Girdwood <[email protected]>
--- doc/index.doxygen | 1 + 1 file changed, 1 insertion(+)
doc/index.doxygen +1 -0
@@ -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>
Signature · 1 line
2.1.4
Takashi Iwai
AppliedAt Mon, 29 Jun 2015 16:25:57 +0100,
Quoted 2 lines · Liam Girdwood
Signed-off-by Liam Girdwood <[email protected]>
Thanks, applied all three patches.
(The next would be to fix doxygen warnings :)
Takashi
Quoted 20 lines
--- doc/doxygen.cfg.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)doc/doxygen.cfg.in +1
-1@@ -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@/testSignature · 1 line
2.1.4
Quoted 7 lines · Takashi Iwai
At Mon, 29 Jun 2015 16:25:57 +0100,
Quoted 2 lines · Liam Girdwood
Signed-off-by Liam Girdwood <[email protected]>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