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
    On Tue, 27 Jun 2006 21:22:51 +0200 Lukas Jelinek wrote:

    > Hello,
    >
    > a few months ago I looked for something like "Linux Kernel API Reference
    > Documentation". This search was unsuccessful and somebody recommended me
    > to generate this documentation from the kernel headers.
    >
    > I have used Doxygen for this work. But the headers have needed to be
    > preprocessed by 'sed' using some regexp rules (due to various
    > incompatible comment formats).
    >
    > Now I decide to share the result worldwide. The current generated
    > "Kernel API Reference" can be found at http://www.kernel-api.org.
    > Although it is very buggy this time I think it may be useful for module
    > developers.
    >
    > To allow this work to be better, I suggest to establish some rules for
    > writing code comments (especially for function prototypes, data
    > structures etc.) and to add the comments to the kernel headers. The
    > rules should be chosen carefully to be well accepted by various
    > documentation generators (at least by Doxygen).

    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...

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

    Q3: Can we see your sed scripts?

    Thanks,
    ---
    ~Randy
    -
    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:22    [W:0.022 / U:92.692 seconds]
    ©2003-2016 Jasper Spaans. hosted at Digital OceanAdvertise on this site