|
From: <sul...@us...> - 2008-10-11 03:28:57
|
Revision: 254
http://gridsim.svn.sourceforge.net/gridsim/?rev=254&view=rev
Author: sulistio
Date: 2008-10-11 03:28:52 +0000 (Sat, 11 Oct 2008)
Log Message:
-----------
add javadoc target to the build file, and minor update to the javadoc script.
Modified Paths:
--------------
trunk/build.xml
trunk/javadoc.sh
Added Paths:
-----------
trunk/source/gridsim/net/fnb/package.html
Modified: trunk/build.xml
===================================================================
--- trunk/build.xml 2008-10-11 03:26:18 UTC (rev 253)
+++ trunk/build.xml 2008-10-11 03:28:52 UTC (rev 254)
@@ -24,6 +24,10 @@
<description>
This is the build file for GridSim
</description>
+
+ <!-- GridSim version number and release year for javadoc -->
+ <property name="version" value="4.2"/>
+ <property name="year" value="2008"/>
<!-- location to store Java classes -->
<property name="class.dir" location="./classes" />
@@ -67,6 +71,25 @@
<delete dir="${class.dir}/gridsim"/>
</target>
+ <target name="javadoc" description="Create Javadocs">
+ <mkdir dir="${doc.dir}" />
+ <javadoc access="package" author="true"
+ version="true" use="true"
+ noqualifier="all"
+ windowtitle="GridSim ${version} API Specification"
+ doctitle="GridSim ${version} API Specification"
+ header="GridSim ${version}"
+ bottom="The University of Melbourne, Australia, ${year}"
+ destdir="${doc.dir}">
+
+ <tag name="invariant" scope="all" description="Invariant:"/>
+ <tag name="pre" scope="all" description="Pre Condition:"/>
+ <tag name="post" scope="all" description="Post Condition:"/>
+ <fileset dir="./source" includes="**/*.java" />
+
+ </javadoc>
+ </target>
+
</project>
Modified: trunk/javadoc.sh
===================================================================
--- trunk/javadoc.sh 2008-10-11 03:26:18 UTC (rev 253)
+++ trunk/javadoc.sh 2008-10-11 03:28:52 UTC (rev 254)
@@ -1,8 +1,8 @@
## A script to run javadoc (Anthony Sept 2004).
-year="2007" # year
-ver="v4.1" # version number
+year="2008" # year
+ver="v4.2" # version number
dir=./source # source directory that contains Java files
doc=./doc # output directory
@@ -17,9 +17,13 @@
-tag pre:a:"Pre Condition:" \
-tag post:a:"Post Condition:" \
-tag invariant:t:"Invariant:" \
+ $dir/eduni/simjava/*.java \
+ $dir/eduni/simjava/distributions/*.java \
$dir/gridsim/*.java \
$dir/gridsim/util/*.java \
$dir/gridsim/net/*.java \
+ $dir/gridsim/net/flow/*.java \
+ $dir/gridsim/net/fnb/*.java \
$dir/gridsim/filter/*.java \
$dir/gridsim/index/*.java \
$dir/gridsim/resFailure/*.java \
Added: trunk/source/gridsim/net/fnb/package.html
===================================================================
--- trunk/source/gridsim/net/fnb/package.html (rev 0)
+++ trunk/source/gridsim/net/fnb/package.html 2008-10-11 03:28:52 UTC (rev 254)
@@ -0,0 +1,5 @@
+<html>
+ <body>
+ Classes that form the finite network buffer extension of <code>GridSim</code>.
+ </body>
+</html>
\ No newline at end of file
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|