From patchwork Mon Jun 29 15:25:58 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Liam Girdwood X-Patchwork-Id: 6689531 Return-Path: X-Original-To: patchwork-alsa-devel@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 68A689F1C1 for ; Mon, 29 Jun 2015 15:26:53 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 8BC06205B8 for ; Mon, 29 Jun 2015 15:26:52 +0000 (UTC) Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) by mail.kernel.org (Postfix) with ESMTP id 422C020520 for ; Mon, 29 Jun 2015 15:26:51 +0000 (UTC) Received: by alsa0.perex.cz (Postfix, from userid 1000) id 35EA22654BC; Mon, 29 Jun 2015 17:26:50 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,NO_DNS_FOR_FROM, UNPARSEABLE_RELAY autolearn=no version=3.3.1 Received: from alsa0.perex.cz (localhost [IPv6:::1]) by alsa0.perex.cz (Postfix) with ESMTP id EED6F265342; Mon, 29 Jun 2015 17:26:23 +0200 (CEST) X-Original-To: alsa-devel@alsa-project.org Delivered-To: alsa-devel@alsa-project.org Received: by alsa0.perex.cz (Postfix, from userid 1000) id 8CEE5265367; Mon, 29 Jun 2015 17:26:20 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by alsa0.perex.cz (Postfix) with ESMTP id 3967C2614AF for ; Mon, 29 Jun 2015 17:26:13 +0200 (CEST) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga101.fm.intel.com with ESMTP; 29 Jun 2015 08:26:12 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.13,699,1427785200"; d="scan'208";a="516002303" Received: from unknown (HELO loki.ger.corp.intel.com) ([10.252.20.74]) by FMSMGA003.fm.intel.com with ESMTP; 29 Jun 2015 08:26:11 -0700 From: Liam Girdwood To: Date: Mon, 29 Jun 2015 16:25:58 +0100 Message-Id: <1435591559-6277-2-git-send-email-liam.r.girdwood@linux.intel.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1435591559-6277-1-git-send-email-liam.r.girdwood@linux.intel.com> References: <1435591559-6277-1-git-send-email-liam.r.girdwood@linux.intel.com> Cc: Takashi Iwai , Liam Girdwood Subject: [alsa-devel] [PATCH 2/3] ucm: docs: Fix doxygen formatting for UCM main page. X-BeenThere: alsa-devel@alsa-project.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Alsa-devel mailing list for ALSA developers - http://www.alsa-project.org" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: alsa-devel-bounces@alsa-project.org Sender: alsa-devel-bounces@alsa-project.org X-Virus-Scanned: ClamAV using ClamSMTP Make sure group is defined and lists dipplayed correctly. Signed-off-by: Liam Girdwood --- 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. */