ALSA: pci/asihpi: fix kernel-doc

Fix W=1 warnings. The code certainly predates .rst syntax, adjust as
needed.

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Link: https://lore.kernel.org/r/20200702193604.169059-5-pierre-louis.bossart@linux.intel.com
Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Pierre-Louis Bossart 2020-07-02 14:35:45 -05:00 committed by Takashi Iwai
parent 232af6a905
commit 7d23b167ec

View file

@ -28,10 +28,12 @@ struct hpi_adapters_list {
static struct hpi_adapters_list adapters; static struct hpi_adapters_list adapters;
/** /**
* Given an HPI Message that was sent out and a response that was received, * hpi_validate_response - Given an HPI Message that was sent out and
* validate that the response has the correct fields filled in, * a response that was received, validate that the response has the
* i.e ObjectType, Function etc * correct fields filled in, i.e ObjectType, Function etc
**/ * @phm: message
* @phr: response
*/
u16 hpi_validate_response(struct hpi_message *phm, struct hpi_response *phr) u16 hpi_validate_response(struct hpi_message *phm, struct hpi_response *phr)
{ {
if (phr->type != HPI_TYPE_RESPONSE) { if (phr->type != HPI_TYPE_RESPONSE) {
@ -106,9 +108,10 @@ void hpi_delete_adapter(struct hpi_adapter_obj *pao)
} }
/** /**
* FindAdapter returns a pointer to the struct hpi_adapter_obj with * hpi_find_adapter - FindAdapter returns a pointer to the struct
* index wAdapterIndex in an HPI_ADAPTERS_LIST structure. * hpi_adapter_obj with index wAdapterIndex in an HPI_ADAPTERS_LIST
* * structure.
* @adapter_index: value in [0, HPI_MAX_ADAPTERS[
*/ */
struct hpi_adapter_obj *hpi_find_adapter(u16 adapter_index) struct hpi_adapter_obj *hpi_find_adapter(u16 adapter_index)
{ {
@ -137,10 +140,9 @@ struct hpi_adapter_obj *hpi_find_adapter(u16 adapter_index)
} }
/** /**
* wipe_adapter_list - wipe an HPI_ADAPTERS_LIST structure.
* *
* wipe an HPI_ADAPTERS_LIST structure. */
*
**/
static void wipe_adapter_list(void) static void wipe_adapter_list(void)
{ {
memset(&adapters, 0, sizeof(adapters)); memset(&adapters, 0, sizeof(adapters));