Re: [PATCH v2] doc: document the kernel-doc conventions for kernelhackers

[Jay Cliburn]

On Fri, 30 May 2008 15:19:41 -0700
Paul Jackson <pj@xxxxxxx> wrote:

> From: Paul Jackson <pj@xxxxxxx>
> 
> Provide documentation of the kernel-doc documentation conventions
> oriented to kernel hackers.
> 
> Since I figure that there will be more people reading this
> kernel-doc-nano-HOWTO.txt file who are kernel developers focused
> on the rest of the kernel, than there will be readers of this
> file who are documentation developers extracting that embedded
> kernel-doc documentation, I have taken the liberty of making
> the new section added here:
> 
>   How to format kernel-doc comments
> 
> the first section of the kernel-doc-nano-HOWTO.txt file.
> 
> This first section is intended to introduce, motivate and
> provide basic usage of the kernel-doc mechanism for kernel
> hackers developing other portions of the kernel.
> 
> Signed-off-by: Paul Jackson <pj@xxxxxxx>
> Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
> Cc: Alan Cox <alan@xxxxxxxxxxxxxxxxxxx>
> 
> ---
>  Documentation/kernel-doc-nano-HOWTO.txt |   99
> ++++++++++++++++++++++++++++++++ 1 file changed, 99 insertions(+)
> 
> --- linux-2.6.orig/Documentation/kernel-doc-nano-HOWTO.txt
> 2008-05-30 08:47:13.000000000 -0700 +++
> linux-2.6/Documentation/kernel-doc-nano-HOWTO.txt	2008-05-30
> 15:14:33.281447922 -0700 @@ -1,6 +1,105 @@ kernel-doc nano-HOWTO
>  =====================
>  
> +How to format kernel-doc comments
> +---------------------------------
> +
> +In order to provide an embedded, 'C' friendly, easy to maintain,
> +but consistent and extractable documentation of the functions and
> +data structures in the Linux kernel, the Linux kernel has adopted
> +a consistent style for documenting functions and their parameters,
> +and structures and their members.
> +
> +The format for this documentation is called the kernel-doc format.
> +It as documented in this Documentation/kernel-doc-nano-HOWTO.txt

s/as/is
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/