Author: mostarda
Date: Sat Mar 24 20:21:03 2012
New Revision: 1304906
URL: http://svn.apache.org/viewvc?rev=1304906&view=rev
Log:
Removed javadoc warnings. Commit related to issue #ANY23-66 .
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVExtractor.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVReaderBuilder.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/HTMLMetaExtractor.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/annotations/package-info.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataExtractor.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/package-info.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdf/TriXExtractor.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/util/StringUtils.java
incubator/any23/trunk/core/src/main/java/org/apache/any23/vocab/CSV.java
incubator/any23/trunk/core/src/test/java/org/apache/any23/extractor/SingleDocumentExtractionTest.java
incubator/any23/trunk/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/package-info.java
incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/plugin/officescraper/ExcelExtractor.java
incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/vocab/Excel.java
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVExtractor.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVExtractor.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVExtractor.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVExtractor.java
Sat Mar 24 20:21:03 2012
@@ -45,7 +45,7 @@ import java.util.Arrays;
* It automatically detects fields <i>delimiter</i>. If not able uses
* the one provided in the <i>Any23</i> configuration.
*
- * @see {@link CSVReaderBuilder}
+ * @see CSVReaderBuilder
* @author Davide Palmisano ( [email protected] )
*/
public class CSVExtractor implements Extractor.ContentExtractor {
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVReaderBuilder.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVReaderBuilder.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVReaderBuilder.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/csv/CSVReaderBuilder.java
Sat Mar 24 20:21:03 2012
@@ -74,7 +74,8 @@ public class CSVReaderBuilder {
* Checks whether the given input stream is a CSV or not.
*
* @param is input stream to be verified.
- * @return
+ * @return <code>true</code> if the given <code>is</code> input stream
contains a <i>CSV</i> content.
+ * <code>false</code> otherwise.
* @throws IOException
*/
public static boolean isCSV(InputStream is) throws IOException {
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/HTMLMetaExtractor.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/HTMLMetaExtractor.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/HTMLMetaExtractor.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/HTMLMetaExtractor.java
Sat Mar 24 20:21:03 2012
@@ -61,9 +61,6 @@ public class HTMLMetaExtractor implement
private String documentLang;
- /**
- * {@inheritDoc}
- */
public final static ExtractorFactory<HTMLMetaExtractor> factory =
SimpleExtractorFactory.create(
NAME,
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java
Sat Mar 24 20:21:03 2012
@@ -243,7 +243,7 @@ public abstract class MicroformatExtract
* This method checks if there is a native nesting relationship between two
* {@link MicroformatExtractor}.
*
- * @see {@link org.apache.any23.extractor.html.annotations.Includes}
+ * @see org.apache.any23.extractor.html.annotations.Includes
* @param including the including {@link MicroformatExtractor}
* @param included the included {@link MicroformatExtractor}
* @return <code>true</code> if there is a declared nesting relationship
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/annotations/package-info.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/annotations/package-info.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/annotations/package-info.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/html/annotations/package-info.java
Sat Mar 24 20:21:03 2012
@@ -19,6 +19,6 @@
* This package contains the annotations needed to describe the
* single nesting relations among different <a
href="http://microformats.org/";>Microformats</a>.
*
- * @see {@link org.apache.any23.extractor.html.MicroformatExtractor}
+ * @see org.apache.any23.extractor.html.MicroformatExtractor
*/
package org.apache.any23.extractor.html.annotations;
\ No newline at end of file
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataExtractor.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataExtractor.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataExtractor.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataExtractor.java
Sat Mar 24 20:21:03 2012
@@ -54,7 +54,7 @@ import java.util.Set;
/**
* Default implementation of <a
href="http://www.w3.org/TR/microdata/";>Microdata</a> extractor,
- * based on {@link TagSoupDOMExtractor}.
+ * based on {@link org.apache.any23.extractor.Extractor.TagSoupDOMExtractor}.
*
* @author Michele Mostarda ([email protected])
* @author Davide Palmisano ( [email protected] )
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java
Sat Mar 24 20:21:03 2012
@@ -168,8 +168,9 @@ public class MicrodataParser {
* @param document document to be processed.
* @param errorMode error management policy.
* @return list of <b>itemscope</b> items.
- * @throws MicrodataParserException if <code>errorMode == {@link
ErrorMode#StopAtFirstError}</code>
- * and an error occurs.
+ * @throws MicrodataParserException if
+ * <code>errorMode == {@link
org.apache.any23.extractor.microdata.MicrodataParser.ErrorMode#StopAtFirstError}</code>
+ * and an error occurs.
*/
public static MicrodataParserReport getMicrodata(Document document,
ErrorMode errorMode)
throws MicrodataParserException {
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/package-info.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/package-info.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/package-info.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/package-info.java
Sat Mar 24 20:21:03 2012
@@ -16,6 +16,6 @@
*/
/**
- * This package contains classes and interfaces modeling the {@link Extractor}
<i>API</i>.
+ * This package contains classes and interfaces modeling the {@link
org.apache.any23.extractor.Extractor} <i>API</i>.
*/
package org.apache.any23.extractor;
\ No newline at end of file
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdf/TriXExtractor.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdf/TriXExtractor.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdf/TriXExtractor.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdf/TriXExtractor.java
Sat Mar 24 20:21:03 2012
@@ -27,7 +27,7 @@ import org.openrdf.rio.helpers.RDFParser
import java.util.Arrays;
/**
- * Concrete implementation of {@link ContentExtractor}
+ * Concrete implementation of {@link
org.apache.any23.extractor.Extractor.ContentExtractor}
* to perform extraction on <a href="http://www.w3.org/2004/03/trix/";>TriX</a>
documents.
*
* @author Michele Mostarda ([email protected])
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java
Sat Mar 24 20:21:03 2012
@@ -119,7 +119,7 @@ public class RDFa11Parser {
* normalizing blanks where present.
*
* @param prefixesDeclaration
- * @return
+ * @return list of extracted prefixes.
*/
protected static String[] extractPrefixSections(String
prefixesDeclaration) {
final String[] parts = prefixesDeclaration.split("\\s");
@@ -317,7 +317,7 @@ public class RDFa11Parser {
*
* @param n current node.
* @param curieOrURIList list of CURIE/URI.
- * @return
+ * @return list of resolved URIs.
* @throws URISyntaxException
*/
protected URI[] resolveCurieOrURIList(Node n, String curieOrURIList,
boolean termAllowed)
@@ -341,8 +341,8 @@ public class RDFa11Parser {
/**
* Resolves a URI string as URI.
*
- * @param uriStr
- * @return
+ * @param uriStr (partial) URI string to be resolved.
+ * @return the resolved URI.
*/
protected URI resolveURI(String uriStr) {
return
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/util/StringUtils.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/util/StringUtils.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/main/java/org/apache/any23/util/StringUtils.java
(original)
+++
incubator/any23/trunk/core/src/main/java/org/apache/any23/util/StringUtils.java
Sat Mar 24 20:21:03 2012
@@ -81,7 +81,8 @@ public class StringUtils {
*
* @param candidatePrefix
* @param container
- * @return
+ * @return <code>true</code> if <code>candidatePrefix</code> is prefix of
<code>container</code>,
+ * <code>false</code> otherwise.
*/
public static boolean isPrefix(String candidatePrefix, String container) {
if(candidatePrefix == null || container == null) {
@@ -103,7 +104,8 @@ public class StringUtils {
*
* @param candidateSuffix
* @param container
- * @return
+ * @return <code>true</code> if <code>candidateSuffix</code> is prefix of
<code>container</code>,
+ * <code>false</code> otherwise.
*/
public static boolean isSuffix(String candidateSuffix, String container) {
if(candidateSuffix == null || container == null) {
Modified:
incubator/any23/trunk/core/src/main/java/org/apache/any23/vocab/CSV.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/main/java/org/apache/any23/vocab/CSV.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
--- incubator/any23/trunk/core/src/main/java/org/apache/any23/vocab/CSV.java
(original)
+++ incubator/any23/trunk/core/src/main/java/org/apache/any23/vocab/CSV.java
Sat Mar 24 20:21:03 2012
@@ -91,7 +91,7 @@ public class CSV extends Vocabulary {
/**
*
* @param localName
- * @return
+ * @return the new URI instance.
*/
public URI createProperty(String localName) {
return createProperty(NS, localName);
Modified:
incubator/any23/trunk/core/src/test/java/org/apache/any23/extractor/SingleDocumentExtractionTest.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/core/src/test/java/org/apache/any23/extractor/SingleDocumentExtractionTest.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/core/src/test/java/org/apache/any23/extractor/SingleDocumentExtractionTest.java
(original)
+++
incubator/any23/trunk/core/src/test/java/org/apache/any23/extractor/SingleDocumentExtractionTest.java
Sat Mar 24 20:21:03 2012
@@ -149,7 +149,7 @@ public class SingleDocumentExtractionTes
* since {@link org.apache.any23.extractor.html.HCardExtractor} declared a
native nesting
* with the {@link org.apache.any23.extractor.html.AdrExtractor}.
*
- * @see {@link org.apache.any23.extractor.html.annotations.Includes}
+ * @see org.apache.any23.extractor.html.annotations.Includes
* @throws IOException
* @throws ExtractionException
* @throws RepositoryException
Modified:
incubator/any23/trunk/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/package-info.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/package-info.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/package-info.java
(original)
+++
incubator/any23/trunk/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/package-info.java
Sat Mar 24 20:21:03 2012
@@ -16,7 +16,7 @@
*/
/**
- * The {@link HTMLScraperExtractor} is a special extractor
+ * The {@link org.apache.any23.plugin.htmlscraper.HTMLScraperExtractor} is a
special extractor
* to scrape textual content from a generic <i>HTML</i> pages.
*/
package org.apache.any23.plugin.htmlscraper;
Modified:
incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/plugin/officescraper/ExcelExtractor.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/plugin/officescraper/ExcelExtractor.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/plugin/officescraper/ExcelExtractor.java
(original)
+++
incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/plugin/officescraper/ExcelExtractor.java
Sat Mar 24 20:21:03 2012
@@ -42,7 +42,7 @@ import java.io.InputStream;
import java.util.Arrays;
/**
- * Implementation of {@link ContentExtractor} able to process
+ * Implementation of {@link
org.apache.any23.extractor.Extractor.ContentExtractor} able to process
* a <i>MS Excel 97-2007+</i> file format <i>.xls/.xlsx</i> and
* convert the detected content to triples.
* This extractor is based on
Modified:
incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/vocab/Excel.java
URL:
http://svn.apache.org/viewvc/incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/vocab/Excel.java?rev=1304906&r1=1304905&r2=1304906&view=diff
==============================================================================
---
incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/vocab/Excel.java
(original)
+++
incubator/any23/trunk/plugins/office-scraper/src/main/java/org/apache/any23/vocab/Excel.java
Sat Mar 24 20:21:03 2012
@@ -125,7 +125,7 @@ public class Excel extends Vocabulary {
/**
*
* @param localName
- * @return
+ * @return the new URI instance.
*/
public URI createProperty(String localName) {
return createProperty(NS, localName);
