From 59058a6e2f87cda232c84eb2c913f095853fe7d1 Mon Sep 17 00:00:00 2001
From: Martin Goik <goik@hdm-stuttgart.de>
Date: Sat, 19 Apr 2014 14:59:04 +0200
Subject: [PATCH] Javadoc corrections
---
.../mi/codeformat/Docbook2docbook.java | 74 +++++++++----------
.../mi/codeformat/DomErrorHandler.java | 2 +-
.../src/main/java/hibintro/v7/User.java | 4 +-
3 files changed, 38 insertions(+), 42 deletions(-)
diff --git a/ws/Docbook/Dbtools/src/main/java/de/hdm_stuttgart/mi/codeformat/Docbook2docbook.java b/ws/Docbook/Dbtools/src/main/java/de/hdm_stuttgart/mi/codeformat/Docbook2docbook.java
index 7a66a4c65..0b90ce984 100644
--- a/ws/Docbook/Dbtools/src/main/java/de/hdm_stuttgart/mi/codeformat/Docbook2docbook.java
+++ b/ws/Docbook/Dbtools/src/main/java/de/hdm_stuttgart/mi/codeformat/Docbook2docbook.java
@@ -1,13 +1,9 @@
package de.hdm_stuttgart.mi.codeformat;
-import java.io.File;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
-import java.net.MalformedURLException;
-import java.net.URL;
-import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
@@ -422,8 +418,8 @@ public class Docbook2docbook {
//Helper functions
/**
- * @param current
- * @return
+ * @param current classpath components being found in @annotations attribute
+ * @return the classpath being defined within element's the ancestry hierarchy
*/
public String findExtraClasspath(final Element current) {
@@ -446,39 +442,39 @@ public class Docbook2docbook {
return findExtraClasspath(parent);
}
- /**
- * @param path
- */
- public static void addURL(String path) {
- File filePath = new File(path);
- try {
- addURL(filePath.toURI().toURL());
- } catch (MalformedURLException e) {
- e.printStackTrace();
- logger.fatal("Error, could not create URL from '" + path + "'");
- System.exit(1);
- }
- }
-
- /**
- * @param u
- */
- public static void addURL(URL u) {
-
- URLClassLoader sysloader = (URLClassLoader) ClassLoader.getSystemClassLoader();
- Class<URLClassLoader> sysclass = URLClassLoader.class;
- final Class<?>[] parameters = new Class[]{URL.class};
-
- try {
- Method method = sysclass.getDeclaredMethod("addURL", parameters);
- method.setAccessible(true);
- method.invoke(sysloader, new Object[]{u});
- } catch (Throwable t) {
- t.printStackTrace();
- logger.error("Error, could not add URL to system classloader");
- System.exit(1);
- }
- }
+// /**
+// * @param path
+// */
+// public static void addURL(String path) {
+// File filePath = new File(path);
+// try {
+// addURL(filePath.toURI().toURL());
+// } catch (MalformedURLException e) {
+// e.printStackTrace();
+// logger.fatal("Error, could not create URL from '" + path + "'");
+// System.exit(1);
+// }
+// }
+//
+// /**
+// * @param u
+// */
+// public static void addURL(URL u) {
+//
+// URLClassLoader sysloader = (URLClassLoader) ClassLoader.getSystemClassLoader();
+// Class<URLClassLoader> sysclass = URLClassLoader.class;
+// final Class<?>[] parameters = new Class[]{URL.class};
+//
+// try {
+// Method method = sysclass.getDeclaredMethod("addURL", parameters);
+// method.setAccessible(true);
+// method.invoke(sysloader, new Object[]{u});
+// } catch (Throwable t) {
+// t.printStackTrace();
+// logger.error("Error, could not add URL to system classloader");
+// System.exit(1);
+// }
+// }
private final String package2path(final String packageName){
String searchDot = "\\.";
diff --git a/ws/Docbook/Dbtools/src/main/java/de/hdm_stuttgart/mi/codeformat/DomErrorHandler.java b/ws/Docbook/Dbtools/src/main/java/de/hdm_stuttgart/mi/codeformat/DomErrorHandler.java
index d6f392439..c25d33e94 100644
--- a/ws/Docbook/Dbtools/src/main/java/de/hdm_stuttgart/mi/codeformat/DomErrorHandler.java
+++ b/ws/Docbook/Dbtools/src/main/java/de/hdm_stuttgart/mi/codeformat/DomErrorHandler.java
@@ -21,7 +21,7 @@ public class DomErrorHandler implements DOMErrorHandler {
}
}
/**
- * @param out
+ * @param out Error messages will go here.
*/
public DomErrorHandler(final PrintStream out) {
this.out = out;
diff --git a/ws/eclipse/HibIntro/src/main/java/hibintro/v7/User.java b/ws/eclipse/HibIntro/src/main/java/hibintro/v7/User.java
index 0b1836802..a40d636a7 100644
--- a/ws/eclipse/HibIntro/src/main/java/hibintro/v7/User.java
+++ b/ws/eclipse/HibIntro/src/main/java/hibintro/v7/User.java
@@ -11,8 +11,8 @@ import org.hibernate.annotations.Index;
/**
* @author goik
*
- * {@link User} instances with a non-uniue index
- * on {@link #cname} for faster database retrieval.
+ * {@link User} instances with a non-unique index
+ * on {@link #getCname()} property for faster database retrieval.
*
*/
@Entity
--
GitLab