Jim Pick wrote:
Hi,
I'm trying to figure out a good way of integrating better documentation
into the project.
The first new document I want to check in is Edouard G. Parmelan's
Porting Kaffe to a new platform document. It's a good one to start
with, since it's already a complete document written
Michael Franz wrote:
Now that I am fooling around with doxygen, I found
that it can actually provide some documentation
without the special tags. It is actually a good
starting point for understanding the API with Kaffe.
Once the tags are added, the documentation will make
it easier to
--- Jim Pick [EMAIL PROTECTED] wrote:
Hi,
I'm trying to figure out a good way of integrating
better documentation
into the project.
Cool.
snip
Additionally, we want to support generating and
shipping Javadoc
documentation (probably using gjdoc as our Javadoc
implemention).
I have
On Sun, 30 Nov 2003 08:10:43 -0800 (PST)
Michael Franz [EMAIL PROTECTED] wrote:
I have been thinking about this for the past few days,
however I am interested in documenting the C code that
makes up Kaffe. I am familiar with HeaderDoc from
Apple and have been looking at GPL alternatives. I
Michael Franz wrote:
I haven't played with it yet, but Doxygen is
extremely popular -- I know
we use it at the place I work. I think that would
be a safe one to go
with. I'm encouraged that there also seems to be a
Maven plugin for it:
http://maven-plugins.sf.net/maven-doxygen-plugin/
So,
Now that I am fooling around with doxygen, I found
that it can actually provide some documentation
without the special tags. It is actually a good
starting point for understanding the API with Kaffe.
Once the tags are added, the documentation will make
it easier to understand what different
