Date: Fri, 17 Feb 2006 08:37:41 +0100
From: Martin Waitz <tali@admingilde.org>
To: Greg KH <greg@kroah.com>
Cc: linux-kernel@vger.kernel.org
Subject: Re: RFC: more documentation in source files
Message-ID: <20060217073741.GB5517@admingilde.org>
Mail-Followup-To: Greg KH <greg@kroah.com>, linux-kernel@vger.kernel.org
References: <20060216214033.GA5517@admingilde.org> <20060216224346.GA17190@kroah.com>
Mime-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="K8nIJk4ghYZn606h"
Content-Disposition: inline
In-Reply-To: <20060216224346.GA17190@kroah.com>
User-Agent: Mutt/1.5.9i
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1810
Lines: 57


--K8nIJk4ghYZn606h
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

hoi :)

On Thu, Feb 16, 2006 at 02:43:46PM -0800, Greg KH wrote:
> What's wrong with just extending kerneldoc in the ways that you feel it
> would be more powerful?

nothing wrong with that, only a lot of work ;-)

> What specifically do you feel is lacking in kerneldoc that doxygen
> provides?

 * it automatically links all structures / function calls in the text
   to their detailed description.
 * it can put descriptive, structured text on one page with
   code documentation.
 * section hierarchy can be defined in the source files by assigning
   documentation blocks to "groups".
 * It's already there.

Most of these things won't be too hard to implement, but nethertheless
it will take some time.  I really don't want to reinvent the wheel.

Well, I'm not really fixed on doxygen, I just wanted to experiment
with other documentation systems to see what they can provide.
If someone can recommend a good one - fine.
If we write it ourself - fine, too.
But I don't want to start extending kernel-doc before taking a look
on alternatives.

--=20
Martin Waitz

--K8nIJk4ghYZn606h
Content-Type: application/pgp-signature; name="signature.asc"
Content-Description: Digital signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)

iD8DBQFD9X1Ej/Eaxd/oD7IRAipUAJwMFXA1rQkTeMpXLShfhttuBkRaCACdGvY/
f+ZHvgoJHYTBgzOGAk0djX8=
=mCWx
-----END PGP SIGNATURE-----

--K8nIJk4ghYZn606h--
-
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/