From 0ba96b399d70eac60ece03f4e438125736169d5b Mon Sep 17 00:00:00 2001 From: Tobias Kellner Date: Tue, 27 Oct 2015 20:12:12 +0100 Subject: JavaDoc fixes --- .../main/java/at/gv/egiz/bku/utils/URLEncodingOutputStream.java | 2 +- .../at/gv/egiz/bku/utils/urldereferencer/URIResolverAdapter.java | 9 ++++----- utils/src/main/java/at/gv/egiz/idlink/IdentityLinkFactory.java | 6 ------ utils/src/main/java/at/gv/egiz/marshal/MarshallerFactory.java | 2 +- .../main/java/at/gv/egiz/marshal/NamespacePrefixMapperImpl.java | 2 +- .../src/main/java/at/gv/egiz/slbinding/RedirectEventFilter.java | 9 ++++----- .../at/gv/egiz/validation/ReportingValidationEventHandler.java | 2 +- 7 files changed, 12 insertions(+), 20 deletions(-) (limited to 'utils/src/main/java/at/gv/egiz') diff --git a/utils/src/main/java/at/gv/egiz/bku/utils/URLEncodingOutputStream.java b/utils/src/main/java/at/gv/egiz/bku/utils/URLEncodingOutputStream.java index 1b4561da..4e6fabef 100644 --- a/utils/src/main/java/at/gv/egiz/bku/utils/URLEncodingOutputStream.java +++ b/utils/src/main/java/at/gv/egiz/bku/utils/URLEncodingOutputStream.java @@ -74,7 +74,7 @@ public class URLEncodingOutputStream extends OutputStream { *

* Note: According to * http://www.w3.org/TR/html40/appendix/notes.html#non-ascii-chars the input - * for the {@link #write()} methods should be the UTF-8. + * for the {@link #write(int)} methods should be the UTF-8. *

* * @param out diff --git a/utils/src/main/java/at/gv/egiz/bku/utils/urldereferencer/URIResolverAdapter.java b/utils/src/main/java/at/gv/egiz/bku/utils/urldereferencer/URIResolverAdapter.java index b08993e6..11a8b7f2 100644 --- a/utils/src/main/java/at/gv/egiz/bku/utils/urldereferencer/URIResolverAdapter.java +++ b/utils/src/main/java/at/gv/egiz/bku/utils/urldereferencer/URIResolverAdapter.java @@ -51,15 +51,14 @@ public class URIResolverAdapter implements URIResolver { /** * - * @param deferecencer + * @param dereferencer * must not be null - * @param ctx may be null */ - public URIResolverAdapter(URLDereferencer deferecencer) { - if (deferecencer == null) { + public URIResolverAdapter(URLDereferencer dereferencer) { + if (dereferencer == null) { throw new NullPointerException("Urlderefencer must not be set to null"); } - this.urlDereferencer = deferecencer; + this.urlDereferencer = dereferencer; } @Override diff --git a/utils/src/main/java/at/gv/egiz/idlink/IdentityLinkFactory.java b/utils/src/main/java/at/gv/egiz/idlink/IdentityLinkFactory.java index ae5cbbd6..4675c403 100644 --- a/utils/src/main/java/at/gv/egiz/idlink/IdentityLinkFactory.java +++ b/utils/src/main/java/at/gv/egiz/idlink/IdentityLinkFactory.java @@ -268,15 +268,9 @@ public class IdentityLinkFactory { * the parent node * @param nextSibling * the next sibling node (may be null) - * @param applyWorkarounds - * apply workarounds as spefiyed by - * {@link #applyWorkarounds(Element, int)} * * @throws JAXBException * if an unexpected error occurs while marshalling - * @throws NullPointerException - * if compressdIdentityLink or parent is - * null */ public void marshallIdentityLink( JAXBElement identityLink, diff --git a/utils/src/main/java/at/gv/egiz/marshal/MarshallerFactory.java b/utils/src/main/java/at/gv/egiz/marshal/MarshallerFactory.java index f4dee552..2d522c83 100644 --- a/utils/src/main/java/at/gv/egiz/marshal/MarshallerFactory.java +++ b/utils/src/main/java/at/gv/egiz/marshal/MarshallerFactory.java @@ -33,7 +33,7 @@ import org.slf4j.LoggerFactory; /** * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class MarshallerFactory { diff --git a/utils/src/main/java/at/gv/egiz/marshal/NamespacePrefixMapperImpl.java b/utils/src/main/java/at/gv/egiz/marshal/NamespacePrefixMapperImpl.java index 799e8b69..6d289124 100644 --- a/utils/src/main/java/at/gv/egiz/marshal/NamespacePrefixMapperImpl.java +++ b/utils/src/main/java/at/gv/egiz/marshal/NamespacePrefixMapperImpl.java @@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory; /** * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class NamespacePrefixMapperImpl extends NamespacePrefixMapper { diff --git a/utils/src/main/java/at/gv/egiz/slbinding/RedirectEventFilter.java b/utils/src/main/java/at/gv/egiz/slbinding/RedirectEventFilter.java index 8bc90ec8..4bde19b0 100644 --- a/utils/src/main/java/at/gv/egiz/slbinding/RedirectEventFilter.java +++ b/utils/src/main/java/at/gv/egiz/slbinding/RedirectEventFilter.java @@ -59,8 +59,7 @@ public class RedirectEventFilter implements EventFilter { * * @param redirectStream * if null, no events are redirected - * @param redirectTriggers - * if null, all events are redirected + * @param encoding */ public RedirectEventFilter(OutputStream redirectStream, String encoding) throws XMLStreamException { // , List redirectTriggers @@ -164,7 +163,7 @@ public class RedirectEventFilter implements EventFilter { * Enable/disable redirection of all events from now on. * The redirected events will be UTF-8 encoded and written to the stream. * - * @param redirectstream + * @param redirectStream * if null, redirection is disabled */ public void setRedirectStream(OutputStream redirectStream) throws XMLStreamException { @@ -186,7 +185,7 @@ public class RedirectEventFilter implements EventFilter { * Enable/disable redirection of all (child) elements contained in redirect triggers. * The redirected events will be UTF-8 encoded and written to the stream. * - * @param redirectstream + * @param redirectStream * if null, redirection is disabled * @param redirectTriggers elements that trigger the redirection */ @@ -199,7 +198,7 @@ public class RedirectEventFilter implements EventFilter { * * TODO: don't set redirect stream from caller (caller does not know whether redirection will be triggered) * rather create on trigger and pass to caller - * @param redirectstream + * @param redirectStream * if null, redirection is disabled * @param encoding The encoding for the redirect stream * @param redirectTriggers elements that trigger the redirection diff --git a/utils/src/main/java/at/gv/egiz/validation/ReportingValidationEventHandler.java b/utils/src/main/java/at/gv/egiz/validation/ReportingValidationEventHandler.java index a9686ca7..c3e196c9 100644 --- a/utils/src/main/java/at/gv/egiz/validation/ReportingValidationEventHandler.java +++ b/utils/src/main/java/at/gv/egiz/validation/ReportingValidationEventHandler.java @@ -31,7 +31,7 @@ import org.slf4j.LoggerFactory; /** * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class ReportingValidationEventHandler implements ValidationEventHandler { -- cgit v1.2.3