Quoting "M. Warner Losh" <[EMAIL PROTECTED]> (from Sun, 28 May 2006
14:01:40 -0600 (MDT)):
In message: <[EMAIL PROTECTED]>
Alexander Leidinger <[EMAIL PROTECTED]> writes:
: We can make this a 3-tier document. We can mark some functions as
: @internal, some without any special ma
Alexander Leidinger <[EMAIL PROTECTED]> writes:
> AFAIK marking them as internal is not possible automatically.
Sure it is. We have the Doxygen source code, don't we?
DES
--
Dag-Erling Smørgrav - [EMAIL PROTECTED]
___
cvs-all@freebsd.org mailing list
On Sun, 28 May 2006, M. Warner Losh wrote:
: > : Since we have no API docs, everyone has to have a look at the kernel on
: > : his own. This only provides a little bit of help here.
: >
: > We have api docs. Please don't say that we have none. There's a
: > bunch of documentation in the man9
Alexander Leidinger wrote this message on Sun, May 28, 2006 at 21:16 +0200:
> Quoting John-Mark Gurney <[EMAIL PROTECTED]> (Sun, 28 May 2006 11:41:15
> -0700):
> A list of commands (like the \brief above) is at
>http://www.stack.nl/~dimitri/doxygen/commands.html
Yeh, that's what I was afraid
In message: <[EMAIL PROTECTED]>
Alexander Leidinger <[EMAIL PROTECTED]> writes:
: Quoting "M. Warner Losh" <[EMAIL PROTECTED]> (Sun, 28 May 2006 13:12:12 -0600
(MDT)):
:
: > In message: <[EMAIL PROTECTED]>
: > Alexander Leidinger <[EMAIL PROTECTED]> writes:
: > : But when
Quoting "M. Warner Losh" <[EMAIL PROTECTED]> (Sun, 28 May 2006 13:12:12 -0600
(MDT)):
> In message: <[EMAIL PROTECTED]>
> Alexander Leidinger <[EMAIL PROTECTED]> writes:
> : But when we have marked the internal functions as such, we can also
> : generate an official version without th
Quoting John-Mark Gurney <[EMAIL PROTECTED]> (Sun, 28 May 2006 11:41:15 -0700):
> Alexander Leidinger wrote this message on Fri, May 26, 2006 at 18:06 +:
> > This is the kernel subsystem API documentation generation framework.
>
> a) where is a guide for the proper bit for documenting, hope
In message <[EMAIL PROTECTED]>, "M. Warner Losh" write
s:
>In message: <[EMAIL PROTECTED]>
>Alexander Leidinger <[EMAIL PROTECTED]> writes:
>: But when we have marked the internal functions as such, we can also
>: generate an official version without the internal functions. It's just
>:
In message: <[EMAIL PROTECTED]>
Alexander Leidinger <[EMAIL PROTECTED]> writes:
: But when we have marked the internal functions as such, we can also
: generate an official version without the internal functions. It's just
: a switch. But so far I think we need to include everything unt
Alexander Leidinger wrote this message on Fri, May 26, 2006 at 18:06 +:
> This is the kernel subsystem API documentation generation framework.
a) where is a guide for the proper bit for documenting, hopefully it's
simply adding a comment block in front of the function.
b) I really hope we
On Sun, 28 May 2006, Alexander Leidinger wrote:
Quoting [EMAIL PROTECTED] (Sun, 28 May 2006 11:12:19 +0900):
Am I allowed to call this a tempest in a teacup?
There, I just have.
While I think that there have been some very good points made both ways, I
believe that since the documentation
On Sun, 28 May 2006, Alexander Leidinger wrote:
Sounds good.
What about adding a comment to the pages which tells everyone that we are
working on this documentation and so far we haven't reviewed every
function and decided if it is an internal one or not.
And the most important point is:
Quoting [EMAIL PROTECTED] (Sun, 28 May 2006 11:12:19 +0900):
> Am I allowed to call this a tempest in a teacup?
>
> There, I just have.
>
> While I think that there have been some very good points made both
> ways, I believe that since the documentation will be generated only by
> people who are
Quoting "Ben Kaduk" <[EMAIL PROTECTED]> (Sat, 27 May 2006 21:06:08 -0500):
> On 5/27/06, Alexander Leidinger <[EMAIL PROTECTED]> wrote:
> > Quoting "Ben Kaduk" <[EMAIL PROTECTED]> (Sat, 27 May 2006 10:27:05 -0500):
> > > Do you mean "not public" here?
> >
> > No. I want to say that we not only ha
Quoting Robert Watson <[EMAIL PROTECTED]> (Sat, 27 May 2006 20:09:54 +0100
(BST)):
>
> On Sat, 27 May 2006, Alexander Leidinger wrote:
>
> >> Can we agree that no functions will be put into publicized documentation
> >> until somebody has considered if the function actually is a public
> >> f
On 5/27/06, Alexander Leidinger <[EMAIL PROTECTED]> wrote:
Quoting "Ben Kaduk" <[EMAIL PROTECTED]> (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 followin
In message <[EMAIL PROTECTED]>, Scott Long writes:
>All very good points. Unfortunately, the very nature of open source
>means that people will go treading into non-APIs if they think that it
>helps them solve a problem.
Of course they will, but I just don't want them to do so because
we provide
On Sat, 27 May 2006, Alexander Leidinger wrote:
There is no automatic way to make this determination, you need somebody to
look at each and every function to decide it.
That's the same way I think about @internal.
@internal is exactly backwards from the way API documentation should work.
T
On Sat, 27 May 2006, Alexander Leidinger wrote:
Can we agree that no functions will be put into publicized documentation
until somebody has considered if the function actually is a public function
or not ?
Does this mean you want to have everything marked as "@internal" by default?
I don't
Quoting "Ben Kaduk" <[EMAIL PROTECTED]> (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 ha
Poul-Henning Kamp wrote:
In message <[EMAIL PROTECTED]>, Alexander Leidinger writes:
Can we agree that no functions will be put into publicized documentation
until somebody has considered if the function actually is a public
function or not ?
Does this mean you want to have everything marke
Alexander,
On 5/27/06, Alexander Leidinger <[EMAIL PROTECTED]> wrote:
Quoting "Poul-Henning Kamp" <[EMAIL PROTECTED]> (Sat, 27 May 2006 10:57:04
+0200):
> In message <[EMAIL PROTECTED]>, Alexander Leidinger writes:
>
> >> Can we agree that no functions will be put into publicized documentation
Quoting "Poul-Henning Kamp" <[EMAIL PROTECTED]> (Sat, 27 May 2006 10:57:04
+0200):
> In message <[EMAIL PROTECTED]>, Alexander Leidinger writes:
>
> >> Can we agree that no functions will be put into publicized documentation
> >> until somebody has considered if the function actually is a public
Quoting "Poul-Henning Kamp" <[EMAIL PROTECTED]> (Sat, 27 May 2006 10:57:04
+0200):
> In message <[EMAIL PROTECTED]>, Alexander Leidinger writes:
>
> >> Can we agree that no functions will be put into publicized documentation
> >> until somebody has considered if the function actually is a public
Quoting "Simon L. Nielsen" <[EMAIL PROTECTED]> (Sat, 27 May 2006 11:12:41
+0200):
> On 2006.05.27 10:57:04 +0200, Poul-Henning Kamp wrote:
>
> > Rather than aim to enable this for the entire kernel and create
> > showel-ware documentation of no value, why don't you start with one
> > subsystem w
On 2006.05.27 10:57:04 +0200, Poul-Henning Kamp wrote:
> Rather than aim to enable this for the entire kernel and create
> showel-ware documentation of no value, why don't you start with one
> subsystem which is currently being worked on and make a usable
> documentation of that subsystem ?
Actua
In message <[EMAIL PROTECTED]>, Alexander Leidinger writes:
>> Can we agree that no functions will be put into publicized documentation
>> until somebody has considered if the function actually is a public
>> function or not ?
>
>Does this mean you want to have everything marked as "@internal" by
Quoting "Poul-Henning Kamp" <[EMAIL PROTECTED]> (Fri, 26 May 2006 23:16:46
+0200):
> In message <[EMAIL PROTECTED]>, Alexander Leidinger writes:
> >Quoting "Poul-Henning Kamp" <[EMAIL PROTECTED]> (Fri, 26 May 2006 20:20:36
> >+0200):
> >
> >> In message <[EMAIL PROTECTED]>, Alexander Leiding
> >
Quoting Sam Leffler <[EMAIL PROTECTED]> (Fri, 26 May 2006 14:17:50 -0700):
> Someone else pointed out to me that the bulk of the discussion about
> this happened under an unrelated subject. I checked arch@ and found
> exactly 3 msgs with doxygen in the subject--2 from gnn and 1 from you.
This wa
Alexander Leidinger wrote:
> Quoting Sam Leffler <[EMAIL PROTECTED]> (Fri, 26 May 2006 11:24:54 -0700):
>
>> Can someone explain the purpose of this? Is the intent to annotate
>> source code for generating documentation? I don't recall seeing a
>> discussion about this.
>
> While the man pages
In message <[EMAIL PROTECTED]>, Alexander Leidinger writes:
>Quoting "Poul-Henning Kamp" <[EMAIL PROTECTED]> (Fri, 26 May 2006 20:20:36
>+0200):
>
>> In message <[EMAIL PROTECTED]>, Alexander Leiding
>> er writes:
>>
>> > This is the kernel subsystem API documentation generation framework.
>> >
Quoting Sam Leffler <[EMAIL PROTECTED]> (Fri, 26 May 2006 11:24:54 -0700):
> Can someone explain the purpose of this? Is the intent to annotate
> source code for generating documentation? I don't recall seeing a
> discussion about this.
While the man pages we have are good references if you kno
Quoting Garance A Drosehn <[EMAIL PROTECTED]> (Fri, 26 May 2006 15:14:27 -0400):
> At 11:24 AM -0700 5/26/06, Sam Leffler wrote:
> >Alexander Leidinger wrote:
> > > Log:
> > > This is the kernel subsystem API documentation generation
> > > framework.
> > >
> > > It uses doxygen to gen
Quoting "Poul-Henning Kamp" <[EMAIL PROTECTED]> (Fri, 26 May 2006 20:20:36
+0200):
> In message <[EMAIL PROTECTED]>, Alexander Leiding
> er writes:
>
> > This is the kernel subsystem API documentation generation framework.
> >
> > It uses doxygen to generate the API documentation. For each s
At 11:24 AM -0700 5/26/06, Sam Leffler wrote:
Alexander Leidinger wrote:
> Log:
> This is the kernel subsystem API documentation generation
> framework.
>
> It uses doxygen to generate the API documentation. [...]
> Requested by: gnn
Can someone explain the purpose of this?
Alexander Leidinger wrote:
> netchild2006-05-26 18:06:07 UTC
>
> FreeBSD src repository
>
> Added files:
> sys/doc/subsys Dependencies Doxyfile-cam Doxyfile-crypto
> Doxyfile-dev_pci Doxyfile-dev_sound
> Doxyfile-dev_usb Doxyfi
In message <[EMAIL PROTECTED]>, Alexander Leiding
er writes:
> This is the kernel subsystem API documentation generation framework.
>
> It uses doxygen to generate the API documentation. For each subsystem
> a very small (about 20 lines with comments) subsystem specific Doxyfile
> has to be
netchild2006-05-26 18:06:07 UTC
FreeBSD src repository
Added files:
sys/doc/subsys Dependencies Doxyfile-cam Doxyfile-crypto
Doxyfile-dev_pci Doxyfile-dev_sound
Doxyfile-dev_usb Doxyfile-geom
Doxyfile-
38 matches
Mail list logo
