lkml.org 
[lkml]   [2003]   [May]   [31]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRe: [PATCH] 2.5 Documentation/CodingStyle ANSI C function declarations.
Date
In article <1054342517.2901.78.camel@spc> you wrote:
> +Function declarations should be new-style:
> +
> +int foo(long bar, long baz, struct magic *xyzzy)
...

I would suggest to include the comment based linux document boiler plates
into that coding style recommendation. In that case it is clear, how you can
document the parameters of a function.

/**
* foo: - do a foo job
* @parameterbar: the bar parameter is used to bar
*
* Description: This is the long description of the function foo() which
* is closely related to bar()
* section header: section description
**/
int foo(long bar, long baz, struct magic *xyzzy)


(I am not sure about the section, and it most likely is helpful to include a
comment, that not all functions should be documented that way.

I realy think it is important to have at least a pointer from the coding
style document to the doc-comments.

Greetings
Bernd
--
eckes privat - http://www.eckes.org/
Project Freefire - http://www.freefire.org/
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

\
 
 \ /
  Last update: 2005-03-22 13:35    [W:0.066 / U:8.408 seconds]
©2003-2017 Jasper Spaans. hosted at Digital OceanAdvertise on this site