Re: DoxyGen Style Kernel API reference.

2009-09-08 Thread Simon 'corecode' Schubert
Matthew Dillon wrote: I've looked at the web site and I do like the concept. I think we could incorporate Doxygen elements in the kernel code as an augmentation of our section 9 manual pages. To be clear, I'm talking about this style of documentation: /** * Short d

Re: DoxyGen Style Kernel API reference.

2009-09-08 Thread Simon 'corecode' Schubert
Matthew Dillon wrote: I've looked at the web site and I do like the concept. I think we could incorporate Doxygen elements in the kernel code as an augmentation of our section 9 manual pages. To be clear, I'm talking about this style of documentation: /** * Short d

Re: DoxyGen Style Kernel API reference.

2009-09-08 Thread Matthew Dillon
I've looked at the web site and I do like the concept. I think we could incorporate Doxygen elements in the kernel code as an augmentation of our section 9 manual pages. To be clear, I'm talking about this style of documentation: /** * Short descript. Longer d

Re: DoxyGen Style Kernel API reference.

2009-09-08 Thread Dennis Melentyev
Hi Sascha and all, 2009/9/4 Sascha Wildner : > Brian Gianforcaro schrieb: >> >> Depending on how nice you want the documentation to be, and how good >> the existing documentation is. >> >> I'd be more than willing to put all my effort into modifying the >> existing comments to be doxygen compliant

Re: DoxyGen Style Kernel API reference.

2009-09-05 Thread Sascha Wildner
Simon 'corecode' Schubert schrieb: Maintaining man9 and doxygen in parallel? I think there is even less chance that developers will care about both man9 & doxygen than taking care of man9 alone. I actually don't think so. Docs can be copied from the doxygen to the man page format. I worked

Re: DoxyGen Style Kernel API reference.

2009-09-05 Thread Simon 'corecode' Schubert
Sascha Wildner wrote: Brian Gianforcaro schrieb: Depending on how nice you want the documentation to be, and how good the existing documentation is. I'd be more than willing to put all my effort into modifying the existing comments to be doxygen compliant, if this what is finally decided. Maint

Re: DoxyGen Style Kernel API reference.

2009-09-04 Thread Sascha Wildner
Brian Gianforcaro schrieb: Depending on how nice you want the documentation to be, and how good the existing documentation is. I'd be more than willing to put all my effort into modifying the existing comments to be doxygen compliant, if this what is finally decided. I wonder, how would the ex

Re: DoxyGen Style Kernel API reference.

2009-09-04 Thread Jeffrey Hsu
On Fri, Sep 4, 2009 at 2:48 PM, Brian Gianforcaro wrote: > Depending on how nice you want the documentation to be, and how good > the existing documentation is. > > I'd be more than willing to put all my effort into modifying the > existing comments to be doxygen compliant, if this what is finally

Re: DoxyGen Style Kernel API reference.

2009-09-04 Thread Brian Gianforcaro
Depending on how nice you want the documentation to be, and how good the existing documentation is. I'd be more than willing to put all my effort into modifying the existing comments to be doxygen compliant, if this what is finally decided. - Brian Gianforcaro On Fri, Sep 4, 2009 at 1:53 PM, Sta

Re: DoxyGen Style Kernel API reference.

2009-09-04 Thread Stathis Kamperis
2009/9/3 Brian Gianforcaro : > > I'm interested in setting up a Doxygen or Doxygen-like documentation > reference for DragonFly-BSD. Would that require modifying existing comments to properly expose the various information to doxygen parser ? Cheers, Stathis

Re: DoxyGen Style Kernel API reference.

2009-09-04 Thread Erik Wikström
On 2009-09-04 11:15, Sascha Wildner wrote: > Brian Gianforcaro schrieb: >> If you could just let me know any of the pro's/con's you see and what your >> vote would be. > > In the doxygen scenario, who would actually _write_ the documentation? > The same people who don't write or adjust the man9

Re: DoxyGen Style Kernel API reference.

2009-09-04 Thread Sdävtaker
If you doing it, Im up to help. Damian On Fri, Sep 4, 2009 at 06:15, Sascha Wildner wrote: > Brian Gianforcaro schrieb: > >> If you could just let me know any of the pro's/con's you see and what your >> vote would be. >> > > In the doxygen scenario, who would actually _write_ the documentation?

Re: DoxyGen Style Kernel API reference.

2009-09-04 Thread Sascha Wildner
Brian Gianforcaro schrieb: If you could just let me know any of the pro's/con's you see and what your vote would be. In the doxygen scenario, who would actually _write_ the documentation? The same people who don't write or adjust the man9 manpages right now? :) Note, that this is not meant

Re: DoxyGen Style Kernel API reference.

2009-09-03 Thread Justin C. Sherrill
On Thu, September 3, 2009 1:28 pm, Brian Gianforcaro wrote: > > I'm interested in setting up a Doxygen or Doxygen-like documentation > reference for DragonFly-BSD. I can't think of a reason to not do it. My only question is who would maintain it? I don't know how much effort it would take over t

Re: DoxyGen Style Kernel API reference.

2009-09-03 Thread Emil Mikulic
On Thu, Sep 03, 2009 at 01:28:49PM -0400, Brian Gianforcaro wrote: > I have noticed that Net/Open/FreeBSD don't have anything similar either. Alexander Leidinger has been working on doxygen-generated docs for FreeBSD. See for example: http://www.leidinger.net/FreeBSD/dox/vm/html/ --Emil

Re: DoxyGen Style Kernel API reference.

2009-09-03 Thread Samuel J. Greear
> I think that's a good idea.  However you will realize that a lot of the > functions are not documented enough to make such a reference useful. >  Considerable work would have to go into actually documenting the functions. Knowing (as in, having a generated list of) what functions need to be docu

Re: DoxyGen Style Kernel API reference.

2009-09-03 Thread Simon 'corecode' Schubert
Brian Gianforcaro wrote: I'm interested in setting up a Doxygen or Doxygen-like documentation reference for DragonFly-BSD. I have been very interested in working on DragonFly for a considerable amount of time. I've realized that for the most part I just have no idea how most of the code works

DoxyGen Style Kernel API reference.

2009-09-03 Thread Brian Gianforcaro
I'm interested in setting up a Doxygen or Doxygen-like documentation reference for DragonFly-BSD. I have been very interested in working on DragonFly for a considerable amount of time. I've realized that for the most part I just have no idea how most of the code works or what underlying API's t