Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, 02 Jul 2022 13:07:42 +0200,
Mauro Carvalho Chehab wrote:
> 
> This file:
> 	sound/core/compress_offload.c
> 
> Doesn't define any docs, as everything is inside the header
> file. So, drop it, in order to remove a Sphinx warning.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>

Hmm, it looks rather like that some comments (at least for exported
functions) should be marked with kerneldoc markers instead.

I'm going to fix those comments.


thanks,

Takashi

> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@xxxxxxxxxx/
> 
>  Documentation/sound/kernel-api/alsa-driver-api.rst | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/Documentation/sound/kernel-api/alsa-driver-api.rst b/Documentation/sound/kernel-api/alsa-driver-api.rst
> index d24c64df7069..3cf8eb4ecaf4 100644
> --- a/Documentation/sound/kernel-api/alsa-driver-api.rst
> +++ b/Documentation/sound/kernel-api/alsa-driver-api.rst
> @@ -86,7 +86,6 @@ Compress Offload
>  
>  Compress Offload API
>  --------------------
> -.. kernel-doc:: sound/core/compress_offload.c
>  .. kernel-doc:: include/uapi/sound/compress_offload.h
>  .. kernel-doc:: include/uapi/sound/compress_params.h
>  .. kernel-doc:: include/sound/compress_driver.h
> -- 
> 2.36.1
> 



[Index of Archives]     [ALSA User]     [Linux Audio Users]     [Pulse Audio]     [Kernel Archive]     [Asterisk PBX]     [Photo Sharing]     [Linux Sound]     [Video 4 Linux]     [Gimp]     [Yosemite News]

  Powered by Linux