cvs commit: src/sys/doc/subsys Dependencies Doxyfile-cam Doxyfile-crypto Doxyfile-dev_pci Doxyfile-dev_sound Doxyfile-dev_usb Doxyfile-geom Doxyfile-i4b Doxyfile-kern Doxyfile-libkern Doxyfile-linux Doxyfile-net80211 ...

[Ben Kaduk]

On 5/27/06, Alexander Leidinger <netchild at freebsd.org> wrote:
> Quoting "Ben Kaduk" <minimarmot at gmail.com> (Sat, 27 May 2006 10:27:05 -0500):
>
> > > At http://www.leidinger.net/FreeBSD/doxygen_notreviewed.png I have a
> > > screenshot of the the index page of the HTML documentation. It shows
> > > the following text in a very prominent position:
> > > ---snip---
> >
> > I have a few comments about the wording of this disclaimer.
> >
> >
> > > IMPORTANT: This API documentation may contain functions which are
> > > either public or for internal use only. Since we have not reviewed
> >
> > Do you mean "not public" here?
>
> No. I want to say that we not only have public function there, but also
> functions for internal use only. I don't know if this is needed. It's
> also ok for me if someone changes this disclaimer completely.

Probably the phrase "this API documentation may contain both functions
which are public and functions that are for internal use only" will
better express this sentiment.

> [snip]
> > Thanks for putting in the work to generate Doxygen documentation.  I
> > am just starting to read the kernel code, and I feel that the call
> > graphs, etc. that it generates will be quite helpful.
>
> And the HTML version is even better to browse than the PDF version I
> have on my website.
>
> Bye,
> Alexander.
>
> --
> Selling GoodYear Eagle F1 235/40ZR18, 2x 4mm + 2x 5mm, ~150 EUR
> you have to pick it up between Germany/Saarland and Luxembourg/Capellen
> http://www.Leidinger.net    Alexander @ Leidinger.net: PGP ID = B0063FE7
> http://www.FreeBSD.org       netchild @ FreeBSD.org  : PGP ID = 72077137
>

That is true -- html is more friendly to switching back and forth.

I think I will follow the discussion in this thread and perhaps make
further suggestions to the disclaimer as necessary.

-Ben Kaduk