[MXD2map-commits] r260:10e0aa283217
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Tue Aug 16 14:34:46 CEST 2011
details: http://hg.intevation.org/geospatial/mxd2map/rev/10e0aa283217
changeset: 260:10e0aa283217
user: raimund renkert <raimund.renkert at intevation.de>
date: Tue Aug 16 14:32:06 2011 +0200
description:
Updated documentation and added ant task for javadoc generation.
diffstat:
ChangeLog | 16 ++++++++++
build.xml | 19 +++++++++++++
properties.xml | 1 +
src/java/de/intevation/mxd/Converter.java | 13 ++++++++
src/java/de/intevation/mxd/reader/AbstractSymbolReader.java | 4 +-
src/java/de/intevation/mxd/reader/FillSymbolReader.java | 4 +-
src/java/de/intevation/mxd/utils/MapToXMLUtils.java | 4 +-
7 files changed, 55 insertions(+), 6 deletions(-)
diffs (163 lines):
diff -r 8fe9ccc77962 -r 10e0aa283217 ChangeLog
--- a/ChangeLog Tue Aug 16 13:09:57 2011 +0200
+++ b/ChangeLog Tue Aug 16 14:32:06 2011 +0200
@@ -1,3 +1,19 @@
+2011-08-16 Raimund Renkert <raimund.renkert at intevation.de>
+
+ Updated documentation and added ant task for javadoc generation.
+
+ * build.xml:
+ Added ant task for javadoc generation.
+
+ * properties.xml:
+ Added directory for javadoc.
+
+ * src\java\de\intevation\mxd\Converter.java,
+ src\java\de\intevation\mxd\reader\AbstractSymbolReader.java,
+ src\java\de\intevation\mxd\reader\FillSymbolReader.java,
+ src\java\de\intevation\mxd\utils\MapToXMLUtils.java:
+ Updated documentation.
+
2011-08-16 Raimund Renkert <raimund.renkert at intevation.de>
* src/java/de/intevation/mxd/writer/MapScriptWriter.java:
diff -r 8fe9ccc77962 -r 10e0aa283217 build.xml
--- a/build.xml Tue Aug 16 13:09:57 2011 +0200
+++ b/build.xml Tue Aug 16 14:32:06 2011 +0200
@@ -127,6 +127,25 @@
<echo message="build directory gone!"/>
</target>
+ <target name="doc" description="Create javadoc.">
+ <javadoc packagenames="de.intevation.mxd.*"
+ sourcepath="${src.dir}"
+ defaultexcludes="yes"
+ destdir="${doc.dir}/javadoc"
+ author="true"
+ version="true"
+ windowtitle="MXD2map">
+ <fileset dir="${src.dir}">
+ <include name="**/*.java" />
+ </fileset>
+ <doctitle><![CDATA[<h1>MXD2map</h1>]]></doctitle>
+ <bottom><![CDATA[<i>Copyright © 2011 Intevation GmbH. All Rights Reserved.</i>]]></bottom>
+ <group title="Reader" packages="de.intevation.mxd.reader.*"/>
+ <group title="Writer" packages="de.intevation.mxd.writer.*"/>
+ <group title="Utilities" packages="de.intevation.mxd.utils.*"/>
+ </javadoc>
+ </target>
+
<target name="help" depends="usage" description="usage" />
<target name="dist" depends="jar" description="create distributable products" />
<target name="run-sample" depends="execute" description="execute the sample with args set in sample.properties"/>
diff -r 8fe9ccc77962 -r 10e0aa283217 properties.xml
--- a/properties.xml Tue Aug 16 13:09:57 2011 +0200
+++ b/properties.xml Tue Aug 16 14:32:06 2011 +0200
@@ -44,6 +44,7 @@
<property name="class.dir" location="${build.dir}/classes"/>
<property name="dist.dir" location="${build.dir}/dist"/>
<property name="libs.dir" location="lib"/>
+<property name="doc.dir" location="doku"/>
<!-- ========================================= -->
<!-- jar file mapping -->
diff -r 8fe9ccc77962 -r 10e0aa283217 src/java/de/intevation/mxd/Converter.java
--- a/src/java/de/intevation/mxd/Converter.java Tue Aug 16 13:09:57 2011 +0200
+++ b/src/java/de/intevation/mxd/Converter.java Tue Aug 16 14:32:06 2011 +0200
@@ -147,6 +147,14 @@
}
}
+
+ /**
+ * Reads a property value from the converter.properties file.
+ *
+ * @param key The property key.
+ *
+ * @return The value.
+ */
private static String readProperty (String key)
throws Exception {
Properties properties = new Properties();
@@ -158,6 +166,8 @@
stream.close();
return properties.getProperty(key);
}
+
+
/**
* Trys to load the Log4j configuration
* from ${config.dir}/log4j.properties.
@@ -176,6 +186,9 @@
}
+ /**
+ * Print out usage informations.
+ */
private static void printUsage() {
System.out.println("Available parameters:[{-m,--mxd} path/to/mxd]\n" +
"\t\t[{-a,--map} path/to/mapfile]\n" +
diff -r 8fe9ccc77962 -r 10e0aa283217 src/java/de/intevation/mxd/reader/AbstractSymbolReader.java
--- a/src/java/de/intevation/mxd/reader/AbstractSymbolReader.java Tue Aug 16 13:09:57 2011 +0200
+++ b/src/java/de/intevation/mxd/reader/AbstractSymbolReader.java Tue Aug 16 14:32:06 2011 +0200
@@ -47,7 +47,7 @@
/**
* Setter for the parent XML element.
*
- * @param parent The XML parent node.
+ * @param p The XML parent node.
*/
public void setParent(Element p) {
this.parent = p;
@@ -56,7 +56,7 @@
/**
* Setter for XML document helper.
*
- * @param util The helper class for storing map information.
+ * @param u The helper class for storing map information.
*/
public void setUtil(MapToXMLUtils u) {
this.util = u;
diff -r 8fe9ccc77962 -r 10e0aa283217 src/java/de/intevation/mxd/reader/FillSymbolReader.java
--- a/src/java/de/intevation/mxd/reader/FillSymbolReader.java Tue Aug 16 13:09:57 2011 +0200
+++ b/src/java/de/intevation/mxd/reader/FillSymbolReader.java Tue Aug 16 14:32:06 2011 +0200
@@ -170,7 +170,7 @@
/**
* Sets the symbol to read.
*
- * @param the symbol used to display polygons.
+ * @param sym The symbol used to display polygons.
*/
public void setSymbol(ISymbol sym) {
this.symbol = sym;
@@ -180,7 +180,7 @@
/**
* Sets the symbol to read.
*
- * @param the symbol used to display polygons.
+ * @param sym The symbol used to display polygons.
*/
public void setSymbol(IFillSymbol sym) {
this.symbol = null;
diff -r 8fe9ccc77962 -r 10e0aa283217 src/java/de/intevation/mxd/utils/MapToXMLUtils.java
--- a/src/java/de/intevation/mxd/utils/MapToXMLUtils.java Tue Aug 16 13:09:57 2011 +0200
+++ b/src/java/de/intevation/mxd/utils/MapToXMLUtils.java Tue Aug 16 14:32:06 2011 +0200
@@ -88,7 +88,7 @@
/**
* Add a layer element to the map.
- * @param name The layer name.
+ *
* @return The layer element.
*/
public Element addLayer()
@@ -110,7 +110,7 @@
/**
* Remove a layer element from map.
- * @param name The layer name.
+ * @param layerElement The layer element.
*/
public void removeLayer(Element layerElement) {
NodeList list = root.getElementsByTagName("map");
More information about the MXD2map-commits
mailing list