Return-Path: Delivered-To: apmail-jackrabbit-dev-archive@www.apache.org Received: (qmail 99156 invoked from network); 31 Jul 2006 15:41:17 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 31 Jul 2006 15:41:17 -0000 Received: (qmail 82520 invoked by uid 500); 31 Jul 2006 15:41:16 -0000 Delivered-To: apmail-jackrabbit-dev-archive@jackrabbit.apache.org Received: (qmail 82234 invoked by uid 500); 31 Jul 2006 15:41:15 -0000 Mailing-List: contact dev-help@jackrabbit.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jackrabbit.apache.org Delivered-To: mailing list dev@jackrabbit.apache.org Received: (qmail 82225 invoked by uid 99); 31 Jul 2006 15:41:15 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 31 Jul 2006 08:41:15 -0700 X-ASF-Spam-Status: No, hits=-0.0 required=10.0 tests=SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (asf.osuosl.org: domain of julian.reschke@gmx.de designates 213.165.64.21 as permitted sender) Received: from [213.165.64.21] (HELO mail.gmx.net) (213.165.64.21) by apache.org (qpsmtpd/0.29) with SMTP; Mon, 31 Jul 2006 08:41:14 -0700 Received: (qmail invoked by alias); 31 Jul 2006 15:40:52 -0000 Received: from mail.greenbytes.de (EHLO [192.168.1.61]) [217.91.35.233] by mail.gmx.net (mp034) with SMTP; 31 Jul 2006 17:40:52 +0200 X-Authenticated: #1915285 Message-ID: <44CE246B.1070708@gmx.de> Date: Mon, 31 Jul 2006 17:40:27 +0200 From: Julian Reschke User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; de; rv:1.8.0.4) Gecko/20060516 Thunderbird/1.5.0.4 Mnenhy/0.7.4.666 MIME-Version: 1.0 To: dev@jackrabbit.apache.org Subject: Patches for JavaDoc warnings Content-Type: multipart/mixed; boundary="------------080608070809000400060406" X-Y-GMX-Trusted: 0 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N --------------080608070809000400060406 Content-Type: text/plain; charset=ISO-8859-15; format=flowed Content-Transfer-Encoding: 7bit Hi, attached is a set of patches to reduce the number of JavaDoc warnings (I guess we don't want to open an issue for that, right? :-). Best regards, Julian --------------080608070809000400060406 Content-Type: text/plain; name="javadoc-patches.diffs.txt" Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="javadoc-patches.diffs.txt" Index: src/main/java/org/apache/jackrabbit/name/Path.java =================================================================== --- src/main/java/org/apache/jackrabbit/name/Path.java (revision 427141) +++ src/main/java/org/apache/jackrabbit/name/Path.java (working copy) @@ -165,7 +165,6 @@ * @param jcrPath * @param resolver * @param normalize - * @return * @throws MalformedPathException * @deprecated Use PathFormat#parse(String, NamespaceResolver)} instead. */ @@ -189,7 +188,6 @@ * @param relJCRPath * @param resolver * @param canonicalize - * @return * @throws MalformedPathException * @deprecated Use {@link PathFormat#parse(Path, String, NamespaceResolver)} instead. */ @@ -213,7 +211,6 @@ * @param parent * @param relPath * @param normalize - * @return * @throws MalformedPathException if relPath is absolute */ public static Path create(Path parent, Path relPath, boolean normalize) @@ -991,8 +988,8 @@ /** * Creates a new path element with the given qualified name and index. * If the name is equals to the name of a special element, like the - * {@link PARENT_ELEMENT},{@link CURRENT_ELEMENT} or the - * {@link ROOT_ELEMENT}, then it's instance is returned. + * {@link #PARENT_ELEMENT},{@link #CURRENT_ELEMENT} or the + * {@link #ROOT_ELEMENT}, then it's instance is returned. *

* the private constructor must never be called but from these 2 methods. * @@ -1017,8 +1014,8 @@ /** * Creates a new path element with the given qualified name and index. * If the name is equals to the name of a special element, like the - * {@link PARENT_ELEMENT},{@link CURRENT_ELEMENT} or the - * {@link ROOT_ELEMENT}, then it's instance is returned. + * {@link #PARENT_ELEMENT},{@link #CURRENT_ELEMENT} or the + * {@link #ROOT_ELEMENT}, then it's instance is returned. *

* the private constructor must never be called but from these 2 methods. * @@ -1271,7 +1268,7 @@ * Returns false. * * @return false - * @see PathElement#denotesName() + * @see Path.PathElement#denotesName() */ public boolean denotesName() { return false; @@ -1281,7 +1278,7 @@ * Returns true. * * @return true - * @see PathElement#denotesRoot() + * @see Path.PathElement#denotesRoot() */ public boolean denotesRoot() { return true; @@ -1291,7 +1288,7 @@ * Returns false. * * @return false - * @see PathElement#denotesParent() + * @see Path.PathElement#denotesParent() */ public boolean denotesParent() { return false; @@ -1301,7 +1298,7 @@ * Returns false. * * @return false - * @see PathElement#denotesCurrent() + * @see Path.PathElement#denotesCurrent() */ public boolean denotesCurrent() { return false; @@ -1345,7 +1342,7 @@ * Returns false. * * @return false - * @see PathElement#denotesName() + * @see Path.PathElement#denotesName() */ public boolean denotesName() { return false; @@ -1355,7 +1352,7 @@ * Returns false. * * @return false - * @see PathElement#denotesRoot() + * @see Path.PathElement#denotesRoot() */ public boolean denotesRoot() { return false; @@ -1365,7 +1362,7 @@ * Returns false. * * @return false - * @see PathElement#denotesParent() + * @see Path.PathElement#denotesParent() */ public boolean denotesParent() { return false; @@ -1375,7 +1372,7 @@ * Returns true. * * @return true - * @see PathElement#denotesCurrent() + * @see Path.PathElement#denotesCurrent() */ public boolean denotesCurrent() { return true; @@ -1418,7 +1415,7 @@ * Returns false. * * @return false - * @see PathElement#denotesName() + * @see Path.PathElement#denotesName() */ public boolean denotesName() { return false; @@ -1428,7 +1425,7 @@ * Returns false. * * @return false - * @see PathElement#denotesRoot() + * @see Path.PathElement#denotesRoot() */ public boolean denotesRoot() { return false; @@ -1438,7 +1435,7 @@ * Returns true. * * @return true - * @see PathElement#denotesParent() + * @see Path.PathElement#denotesParent() */ public boolean denotesParent() { return true; @@ -1448,7 +1445,7 @@ * Returns false. * * @return false - * @see PathElement#denotesCurrent() + * @see Path.PathElement#denotesCurrent() */ public boolean denotesCurrent() { return false; @@ -1490,7 +1487,7 @@ * Returns true. * * @return true - * @see PathElement#denotesName() + * @see Path.PathElement#denotesName() */ public boolean denotesName() { return true; @@ -1500,7 +1497,7 @@ * Returns false. * * @return false - * @see PathElement#denotesRoot() + * @see Path.PathElement#denotesRoot() */ public boolean denotesRoot() { return false; @@ -1510,7 +1507,7 @@ * Returns false. * * @return false - * @see PathElement#denotesParent() + * @see Path.PathElement#denotesParent() */ public boolean denotesParent() { return false; @@ -1520,7 +1517,7 @@ * Returns false. * * @return false - * @see PathElement#denotesCurrent() + * @see Path.PathElement#denotesCurrent() */ public boolean denotesCurrent() { return false; Index: src/main/java/org/apache/jackrabbit/core/query/LocationStepQueryNode.java =================================================================== --- src/main/java/org/apache/jackrabbit/core/query/LocationStepQueryNode.java (revision 427141) +++ src/main/java/org/apache/jackrabbit/core/query/LocationStepQueryNode.java (working copy) @@ -120,7 +120,7 @@ /** * Sets a new value for the includeDescendants property. * @param include the new value. - * @see {@link #getIncludeDescendants()} + * @see #getIncludeDescendants() */ public void setIncludeDescendants(boolean include) { this.includeDescendants = include; Index: src/main/java/org/apache/jackrabbit/core/query/xpath/XPathQueryBuilder.java =================================================================== --- src/main/java/org/apache/jackrabbit/core/query/xpath/XPathQueryBuilder.java (revision 427141) +++ src/main/java/org/apache/jackrabbit/core/query/xpath/XPathQueryBuilder.java (working copy) @@ -886,7 +886,7 @@ * Returns true if node has a child node which is the attribute * axis. * - * @param node a node with type {@link org.apache.jackrabbit.core.query.xpath.XPathTreeConstants.JJTSTEPEXPR}. + * @param node a node with type {@link org.apache.jackrabbit.core.query.xpath.XPathTreeConstants#JJTSTEPEXPR}. * @return true if this step expression uses the attribute axis. */ private boolean isAttributeAxis(SimpleNode node) { Index: src/main/java/org/apache/jackrabbit/core/query/sql/JCRSQLQueryBuilder.java =================================================================== --- src/main/java/org/apache/jackrabbit/core/query/sql/JCRSQLQueryBuilder.java (revision 427141) +++ src/main/java/org/apache/jackrabbit/core/query/sql/JCRSQLQueryBuilder.java (working copy) @@ -63,7 +63,7 @@ /** * DateFormat pattern for type - * {@link org.apache.jackrabbit.core.query.QueryConstants.TYPE_DATE}. + * {@link org.apache.jackrabbit.core.query.QueryConstants#TYPE_DATE}. */ private static final String DATE_PATTERN = "yyyy-MM-dd"; Index: src/main/java/org/apache/jackrabbit/value/ValueFactoryImpl.java =================================================================== --- src/main/java/org/apache/jackrabbit/value/ValueFactoryImpl.java (revision 427141) +++ src/main/java/org/apache/jackrabbit/value/ValueFactoryImpl.java (working copy) @@ -43,7 +43,6 @@ //-------------------------------------------------------------------------- /** * - * @return */ public static ValueFactory getInstance() { return valueFactory; Index: src/main/java/org/apache/jackrabbit/value/ValueHelper.java =================================================================== --- src/main/java/org/apache/jackrabbit/value/ValueHelper.java (revision 427141) +++ src/main/java/org/apache/jackrabbit/value/ValueHelper.java (working copy) @@ -54,7 +54,6 @@ * * @param srcValue * @param targetType - * @return * @throws ValueFormatException * @throws IllegalArgumentException * @deprecated Use {@link #convert(String, int, ValueFactory)} instead. @@ -69,7 +68,6 @@ * @param srcValue * @param targetType * @param factory - * @return * @throws ValueFormatException * @throws IllegalArgumentException * @see #convert(Value, int, ValueFactory) @@ -89,7 +87,6 @@ * * @param srcValue * @param targetType - * @return * @throws ValueFormatException * @throws IllegalArgumentException * @deprecated Use {@link #convert(InputStream, int, ValueFactory)} instead. @@ -103,7 +100,6 @@ * @param srcValue * @param targetType * @param factory - * @return * @throws ValueFormatException * @throws IllegalArgumentException */ @@ -122,7 +118,6 @@ * * @param srcValues * @param targetType - * @return * @throws ValueFormatException * @throws IllegalArgumentException * @deprecated Use {@link #convert(String[], int, ValueFactory)} instead. @@ -139,7 +134,6 @@ * * @param srcValues * @param targetType - * @return * @throws ValueFormatException * @throws IllegalArgumentException * @see #convert(Value, int, ValueFactory) @@ -159,7 +153,6 @@ /** * @param srcValues * @param targetType - * @return * @throws ValueFormatException * @throws IllegalArgumentException * @see #convert(Value, int, ValueFactory) @@ -183,7 +176,6 @@ * * @param srcValues * @param targetType - * @return * @throws ValueFormatException * @throws IllegalArgumentException * @deprecated Use {@link #convert(Value[], int, ValueFactory)} instead. @@ -198,7 +190,6 @@ * @param srcValues * @param targetType * @param factory - * @return * @throws ValueFormatException * @throws IllegalArgumentException * @see #convert(Value, int, ValueFactory) @@ -237,7 +228,6 @@ * @param srcValue * @param targetType - * @return * @throws ValueFormatException * @throws IllegalStateException * @throws IllegalArgumentException @@ -258,7 +248,6 @@ * @param srcValue * @param targetType * @param factory - * @return * @throws ValueFormatException * @throws IllegalStateException * @throws IllegalArgumentException @@ -469,7 +458,6 @@ * Same as {@link #copy(Value, ValueFactory)} using ValueFactoryImpl. * * @param srcValue - * @return * @throws IllegalStateException * @deprecated Use {@link #copy(Value, ValueFactory)} instead. */ @@ -481,7 +469,6 @@ * * @param srcValue * @param factory - * @return * @throws IllegalStateException */ public static Value copy(Value srcValue, ValueFactory factory) @@ -533,7 +520,6 @@ * Same as {@link #copy(Value[], ValueFactory)} using ValueFactoryImpl. * * @param srcValues - * @return * @throws IllegalStateException * @deprecated Use {@link #copy(Value[], ValueFactory)} instead. */ @@ -544,7 +530,6 @@ /** * @param srcValues * @param factory - * @return * @throws IllegalStateException */ public static Value[] copy(Value[] srcValues, ValueFactory factory) --------------080608070809000400060406--