From patchwork Thu Mar 5 12:51:57 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tanu Kaskinen X-Patchwork-Id: 5945721 Return-Path: X-Original-To: patchwork-alsa-devel@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id F3C80BF440 for ; Thu, 5 Mar 2015 12:52:44 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 0683F20381 for ; Thu, 5 Mar 2015 12:52:44 +0000 (UTC) Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) by mail.kernel.org (Postfix) with ESMTP id B1363201BC for ; Thu, 5 Mar 2015 12:52:42 +0000 (UTC) Received: by alsa0.perex.cz (Postfix, from userid 1000) id D37B72658B1; Thu, 5 Mar 2015 13:52:41 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 Received: from alsa0.perex.cz (localhost [IPv6:::1]) by alsa0.perex.cz (Postfix) with ESMTP id CC9BE26573D; Thu, 5 Mar 2015 13:52:11 +0100 (CET) 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 DAC9F2654E6; Thu, 5 Mar 2015 13:52:10 +0100 (CET) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by alsa0.perex.cz (Postfix) with ESMTP id 76F5026047B for ; Thu, 5 Mar 2015 13:52:03 +0100 (CET) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga101.fm.intel.com with ESMTP; 05 Mar 2015 04:52:03 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.11,346,1422950400"; d="scan'208";a="694343517" Received: from tkkaskin-mobl3.tm.intel.com ([10.237.50.55]) by orsmga002.jf.intel.com with ESMTP; 05 Mar 2015 04:52:01 -0800 From: Tanu Kaskinen To: alsa-devel@alsa-project.org Date: Thu, 5 Mar 2015 14:51:57 +0200 Message-Id: <1425559918-23075-2-git-send-email-tanu.kaskinen@linux.intel.com> X-Mailer: git-send-email 1.9.3 In-Reply-To: <1425559918-23075-1-git-send-email-tanu.kaskinen@linux.intel.com> References: <1425559918-23075-1-git-send-email-tanu.kaskinen@linux.intel.com> Cc: tiwai@suse.de, liam.r.girdwood@linux.intel.com, han.lu@intel.com Subject: [alsa-devel] [PATCH v2 1/2] ucm: reformat snd_use_case_get() doc 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 Doxygen doesn't preserve formatting that relies only on indentation. This fixes it by using lists more liberally. There are probably more places to fix than just snd_use_case_get_list(), but I only have motivation for fixing this function's documentation formatting (the next patch will add some more content to the function's documentation). Signed-off-by: Tanu Kaskinen --- include/use-case.h | 111 +++++++++++++++++++++++++++++++---------------------- 1 file changed, 65 insertions(+), 46 deletions(-) diff --git a/include/use-case.h b/include/use-case.h index 3728906..d309522 100644 --- a/include/use-case.h +++ b/include/use-case.h @@ -229,10 +229,10 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr, * "const", but it's too late to fix it, sorry about that.) * * Known identifiers: - * NULL - return current card - * _verb - return current verb + * - NULL - return current card + * - _verb - return current verb * - * [=]{NAME}[/[{modifier}|{/device}][/{verb}]] + * - [=]{NAME}[/[{modifier}|{/device}][/{verb}]] * - value identifier {NAME} * - Search starts at given modifier or device if any, * else at a verb @@ -243,51 +243,70 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr, * device/modifier/verb specified, and not search * through each object in turn. * - Examples: - * "PlaybackPCM/Play Music" - * "CapturePCM/SPDIF" - * From ValueDefaults only: - * "=Variable" - * From current active verb: - * "=Variable//" - * From verb "Verb": - * "=Variable//Verb" - * From "Modifier" in current active verb: - * "=Variable/Modifier/" - * From "Modifier" in "Verb": - * "=Variable/Modifier/Verb" + * - "PlaybackPCM/Play Music" + * - "CapturePCM/SPDIF" + * - From ValueDefaults only: + * "=Variable" + * - From current active verb: + * "=Variable//" + * - From verb "Verb": + * "=Variable//Verb" + * - From "Modifier" in current active verb: + * "=Variable/Modifier/" + * - From "Modifier" in "Verb": + * "=Variable/Modifier/Verb" * * Recommended names for values: - * TQ - Tone Quality - * PlaybackPCM - full PCM playback device name - * PlaybackPCMIsDummy - Valid values: "yes" and "no". If set to "yes", the - * PCM named by the PlaybackPCM value is a dummy device, - * meaning that opening it enables an audio path in the - * hardware, but writing to the PCM device has no - * effect. - * CapturePCM - full PCM capture device name - * CapturePCMIsDummy - Valid values: "yes" and "no". If set to "yes", the - * PCM named by the CapturePCM value is a dummy device, - * meaning that opening it enables an audio path in the - * hardware, but reading from the PCM device has no - * effect. - * PlaybackRate - playback device sample rate - * PlaybackChannels - playback device channel count - * PlaybackCTL - playback control device name - * PlaybackVolume - playback control volume ID string - * PlaybackSwitch - playback control switch ID string - * CaptureRate - capture device sample rate - * CaptureChannels - capture device channel count - * CaptureCTL - capture control device name - * CaptureVolume - capture control volume ID string - * CaptureSwitch - capture control switch ID string - * PlaybackMixer - name of playback mixer - * PlaybackMixerID - mixer playback ID - * CaptureMixer - name of capture mixer - * CaptureMixerID - mixer capture ID - * JackDev - jack device name - * JackControl - jack control name - * JackHWMute - indicate if the HW mutes a device on jack insertion - * or not. + * - TQ + * - Tone Quality + * - PlaybackPCM + * - full PCM playback device name + * - PlaybackPCMIsDummy + * - Valid values: "yes" and "no". If set to "yes", the PCM named by the + * PlaybackPCM value is a dummy device, meaning that opening it enables + * an audio path in the hardware, but writing to the PCM device has no + * effect. + * - CapturePCM + * - full PCM capture device name + * - CapturePCMIsDummy + * - Valid values: "yes" and "no". If set to "yes", the PCM named by the + * CapturePCM value is a dummy device, meaning that opening it enables + * an audio path in the hardware, but reading from the PCM device has no + * effect. + * - PlaybackRate + * - playback device sample rate + * - PlaybackChannels + * - playback device channel count + * - PlaybackCTL + * - playback control device name + * - PlaybackVolume + * - playback control volume ID string + * - PlaybackSwitch + * - playback control switch ID string + * - CaptureRate + * - capture device sample rate + * - CaptureChannels + * - capture device channel count + * - CaptureCTL + * - capture control device name + * - CaptureVolume + * - capture control volume ID string + * - CaptureSwitch + * - capture control switch ID string + * - PlaybackMixer + * - name of playback mixer + * - PlaybackMixerID + * - mixer playback ID + * - CaptureMixer + * - name of capture mixer + * - CaptureMixerID + * - mixer capture ID + * - JackDev + * - jack device name + * - JackControl + * - jack control name + * - JackHWMute + * - indicate if the HW mutes a device on jack insertion or not. */ int snd_use_case_get(snd_use_case_mgr_t *uc_mgr, const char *identifier,