lkml.org 
[lkml]   [2006]   [Jun]   [27]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: Kernel API Reference Documentation
 >
> FYI, there are already some kernel-doc rules in
> Documentation/kernel-doc-nano-HOWTO.txt. These rules work with the
> doc. generator in the kernel tree (scripts/kernel-doc).
> Do you have suggestions for how to make them (the rules) better?
> so that the in-tree kernel doc. will improve...

These rules seem to be good. I will try to use the generator
(scripts/kernel-doc) and check the result.

But the bigger problem is that many headers are not documented at all.
And some code is documented but not complying the rules.

>
> Q2: what do I get when I download one of the tarballs from kernel-api.org?
>

Each tarball contains exactly the same as can be browsed online at
kernel-api.org. There is no difference.


> Q3: Can we see your sed scripts?
>

Yes, here it is (it's really small and mindless):

--- sed script begin ---
/^\(\s\)*#endif/ {
s/\/\*/\/\//
s/\*\///
}
/^\(\s\)*\/\*.*\*\/\(\s\)*$/ {
s/\/\*/\/\/\//
s/\*\///
}
/^.*\/\*.*\*\/\(\s\)*$/ {
s/\/\*/\/\/\/</
s/\*\///
}
s/^\(\s\)*\/\*/\/\*\*\n/

s/^.*\*\//\n\*\//
--- sed script end ---
-
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: 2006-06-27 22:44    [from the cache]
©2003-2011 Jasper Spaans. Advertise on this site