You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Matthias Dorfner <po...@matthias-dorfner.de> on 2008/09/08 15:56:58 UTC
Maven & documentation
Hello everybody,
the task for my diploma thesis is to implement Maven for an existing software project whose API is written in Java. The thing is that my boss wants besides the revision & configuration management a good documentation for the already existing API (which you can also show customers to explain them the API in a more illustrative way).
I’ve read something about Maven being NOT a documentation tool, so am I right with this powerful piece of software? What features/support can I use for documentation issues without programming a lot on my own?
Secondly, does someone know who’s the “founder” or creative director behind Maven, cause I want to ask him/her to do an expert interview for my diploma thesis?
Thank you very much and have a nice day!
Greetz,
Matthias
Re: Maven & documentation
Posted by Karl Heinz Marbaise <kh...@gmx.de>.
Hi Matthias,
>
> the task for my diploma thesis is to implement Maven for an existing software project whose API is written in Java.
> the thing is that my boss wants besides the revision & configuration
> management a good documentation for the already existing API (which
you can
> also show customers to explain them the API in a more
> illustrative way).
Take a look at http://maven.apache.org/doxia/book/index.html
there you can create a book via XML file and convert it into XDoc, PDF,
RTF and LaTeX ...
That might be an approach....the XDoc can be integrated into the
Maven process and used to create an online documentation with the same
contents as the resulted book ....
Kind regards
Karl Heinz Marbaise
--
SoftwareEntwicklung Beratung Schulung Tel.: +49 (0) 2405 / 415 893
Dipl.Ing.(FH) Karl Heinz Marbaise ICQ#: 135949029
Hauptstrasse 177 USt.IdNr: DE191347579
52146 Würselen http://www.soebes.de
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE: Maven & documentation
Posted by Andreas Guther <An...@markettools.com>.
You might get some information about Maven history from Wikipedia:
http://en.wikipedia.org/wiki/Apache_Maven
Andreas
-----Original Message-----
From: Matthias Dorfner [mailto:post@matthias-dorfner.de]
Sent: Monday, September 08, 2008 6:57 AM
To: users@maven.apache.org
Subject: Maven & documentation
Hello everybody,
the task for my diploma thesis is to implement Maven for an existing software project whose API is written in Java. The thing is that my boss wants besides the revision & configuration management a good documentation for the already existing API (which you can also show customers to explain them the API in a more illustrative way).
I’ve read something about Maven being NOT a documentation tool, so am I right with this powerful piece of software? What features/support can I use for documentation issues without programming a lot on my own?
Secondly, does someone know who’s the “founder” or creative director behind Maven, cause I want to ask him/her to do an expert interview for my diploma thesis?
Thank you very much and have a nice day!
Greetz,
Matthias