<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	>
<channel>
	<title>Comments on: Good Javadoc use</title>
	<atom:link href="http://blog.cherouvim.com/good-javadoc-use/feed/" rel="self" type="application/rss+xml" />
	<link>http://blog.cherouvim.com/good-javadoc-use/</link>
	<description>software engineering for beginners</description>
	<pubDate>Thu, 20 Nov 2008 13:31:42 +0000</pubDate>
	<generator>http://wordpress.org/?v=2.5</generator>
		<item>
		<title>By: cherouvim</title>
		<link>http://blog.cherouvim.com/good-javadoc-use/#comment-884</link>
		<dc:creator>cherouvim</dc:creator>
		<pubDate>Thu, 23 Aug 2007 18:23:30 +0000</pubDate>
		<guid isPermaLink="false">http://blog.cherouvim.com/good-javadoc-use/#comment-884</guid>
		<description>Yep, package.html is nice.

Thanks!</description>
		<content:encoded><![CDATA[<p>Yep, package.html is nice.</p>
<p>Thanks!</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: John Kostaras</title>
		<link>http://blog.cherouvim.com/good-javadoc-use/#comment-878</link>
		<dc:creator>John Kostaras</dc:creator>
		<pubDate>Thu, 23 Aug 2007 09:17:24 +0000</pubDate>
		<guid isPermaLink="false">http://blog.cherouvim.com/good-javadoc-use/#comment-878</guid>
		<description>If you want to have a nice Javadoc API as the one of JDK, ie. with the packages on the upper left, all classes on lower left etc. then I use the following script to create my Javadoc:

&lt;pre&gt;rem This will create the API for  application
rem YOU MUST EDIT THE SETTINGS IN THIS FILE TO MATCH YOUR CONFIGURATION

rem Save old classpath
set OLD_CP=%CLASSPATH%

rem Output directory
rem CHANGE THIS TO THE FOLDER YOU WISH TO CREATE THE API DOCUMENTATION
set OUTPUT_FOLDER=..\doc\api

rem Application top-level directory
rem CHANGE THIS TO MATCH YOUR CONFIGURATION
set APP_HOME=.

rem CLASSPATH 
set CLASSPATH=.;%APP_HOME%;

javadoc -d "%OUTPUT_FOLDER%" -windowtitle " - Copyright @ 2006-2007" -doctitle " API Specification" -bottom  "&lt;i&gt;©, &lt;/i&gt;" -classpath %classpath%  -package -author -version @packages.txt

rem Restore old classpath
set CLASSPATH=%OLD_CP%&lt;/pre&gt;

Save the above to a .bat or .cmd or .sh file in the top directory of your application, e.g. where folder app is, if app is the name of the root package of your application.

You also need a packages.txt file in the same directory which contains the names of all the packages of your application one per line, i.e. in the form:
app
app.db
app.io
app.io.ui
app.help
etc.

Inside each package you must have a package.html file with the following ingredients:
&lt;pre&gt;Application package

bla bla bla description of the package bla bla bla&lt;/pre&gt;


Here you modify the title and the body. You must add a package.html to every package and sub-package of your application.

I know it is a lot of work, but Voila.</description>
		<content:encoded><![CDATA[<p>If you want to have a nice Javadoc API as the one of JDK, ie. with the packages on the upper left, all classes on lower left etc. then I use the following script to create my Javadoc:</p>
<pre>rem This will create the API for  application
rem YOU MUST EDIT THE SETTINGS IN THIS FILE TO MATCH YOUR CONFIGURATION

rem Save old classpath
set OLD_CP=%CLASSPATH%

rem Output directory
rem CHANGE THIS TO THE FOLDER YOU WISH TO CREATE THE API DOCUMENTATION
set OUTPUT_FOLDER=..\doc\api

rem Application top-level directory
rem CHANGE THIS TO MATCH YOUR CONFIGURATION
set APP_HOME=.

rem CLASSPATH
set CLASSPATH=.;%APP_HOME%;

javadoc -d "%OUTPUT_FOLDER%" -windowtitle " - Copyright @ 2006-2007" -doctitle " API Specification" -bottom  "<i>©, </i>&#8221; -classpath %classpath%  -package -author -version @packages.txt

rem Restore old classpath
set CLASSPATH=%OLD_CP%</pre>
<p>Save the above to a .bat or .cmd or .sh file in the top directory of your application, e.g. where folder app is, if app is the name of the root package of your application.</p>
<p>You also need a packages.txt file in the same directory which contains the names of all the packages of your application one per line, i.e. in the form:<br />
app<br />
app.db<br />
app.io<br />
app.io.ui<br />
app.help<br />
etc.</p>
<p>Inside each package you must have a package.html file with the following ingredients:</p>
<pre>Application package

bla bla bla description of the package bla bla bla</pre>
<p>Here you modify the title and the body. You must add a package.html to every package and sub-package of your application.</p>
<p>I know it is a lot of work, but Voila.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Sakisk</title>
		<link>http://blog.cherouvim.com/good-javadoc-use/#comment-848</link>
		<dc:creator>Sakisk</dc:creator>
		<pubDate>Tue, 31 Jul 2007 18:38:57 +0000</pubDate>
		<guid isPermaLink="false">http://blog.cherouvim.com/good-javadoc-use/#comment-848</guid>
		<description>Αν και microsoft developer, ο ίδιος, πάντα μου άρεσε το πόσο καλά δομημένο και λειτουργικό εργαλείο είναι το javadoc. Είναι κρίμα που δεν διαθέτουμε λίγο παραπάνω χρόνο να γράφουμε καλό documentation με τον κώδικά μας...
Για τους microsoftαδες υπάρχει το Sandcastle (νομίζω της microsoft)
http://www.sandcastledocs.com/Wiki%20Pages/Home.aspx
και το open source Ndoc
http://ndoc.sourceforge.net/
Αυτά έχω χρησιμοποιήσει και είναι αρκετά καλά.</description>
		<content:encoded><![CDATA[<p>Αν και microsoft developer, ο ίδιος, πάντα μου άρεσε το πόσο καλά δομημένο και λειτουργικό εργαλείο είναι το javadoc. Είναι κρίμα που δεν διαθέτουμε λίγο παραπάνω χρόνο να γράφουμε καλό documentation με τον κώδικά μας&#8230;<br />
Για τους microsoftαδες υπάρχει το Sandcastle (νομίζω της microsoft)<br />
<a href="http://www.sandcastledocs.com/Wiki%20Pages/Home.aspx" rel="nofollow">http://www.sandcastledocs.com/Wiki%20Pages/Home.aspx</a><br />
και το open source Ndoc<br />
<a href="http://ndoc.sourceforge.net/" rel="nofollow">http://ndoc.sourceforge.net/</a><br />
Αυτά έχω χρησιμοποιήσει και είναι αρκετά καλά.</p>
]]></content:encoded>
	</item>
</channel>
</rss>
