Permalink
Browse files

More JavaDoc fixes

  • Loading branch information...
1 parent c5018ca commit b7db1519632dc4110430e934997a6a1407dbfd1b @rolfl rolfl committed Feb 28, 2012
Showing with 47 additions and 0 deletions.
  1. +47 −0 core/src/java/org/jdom2/filter/Filters.java
@@ -123,20 +123,27 @@ private Filters() {
}
/**
+ * Return a Filter that matches any {@link Content} data.
+ *
* @return a Filter that matches any {@link Content} data.
*/
public static final Filter<Content> content() {
return fcontent;
}
/**
+ * Return a Filter that matches any {@link Attribute} data.
+ *
* @return a Filter that matches any {@link Attribute} data.
*/
public static final Filter<Attribute> attribute() {
return fattribute;
}
/**
+ * Return a Filter that matches any {@link Attribute} data with the
+ * specified name.
+ *
* @param name The name for all the Attributes to have (these can be in any
* Namespace).
* @return a Filter that matches any {@link Attribute} data with the
@@ -147,6 +154,9 @@ private Filters() {
}
/**
+ * Return a Filter that matches any {@link Attribute} data with the
+ * specified name and namespace.
+ *
* @param name The name for all the Attributes to have.
* @param ns The Namespace for all the Attributes to have.
* @return a Filter that matches any {@link Attribute} data with the
@@ -157,6 +167,9 @@ private Filters() {
}
/**
+ * Return a Filter that matches any {@link Attribute} data with the
+ * specified namespace.
+ *
* @param ns The Namespace for all the Attributes to have.
* @return a Filter that matches any {@link Attribute} data with the
* specified namespace.
@@ -166,48 +179,63 @@ private Filters() {
}
/**
+ * Return a Filter that matches any {@link Comment} data.
+ *
* @return a Filter that matches any {@link Comment} data.
*/
public static final Filter<Comment> comment() {
return fcomment;
}
/**
+ * Return a Filter that matches any {@link CDATA} data.
+ *
* @return a Filter that matches any {@link CDATA} data.
*/
public static final Filter<CDATA> cdata() {
return fcdata;
}
/**
+ * Return a Filter that matches any {@link DocType} data.
+ *
* @return a Filter that matches any {@link DocType} data.
*/
public static final Filter<DocType> doctype() {
return fdoctype;
}
/**
+ * Return a Filter that matches any {@link EntityRef} data.
+ *
* @return a Filter that matches any {@link EntityRef} data.
*/
public static final Filter<EntityRef> entityref() {
return fentityref;
}
/**
+ * Return a Filter that matches any {@link Element} data.
+ *
* @return a Filter that matches any {@link Element} data.
*/
public static final Filter<Element> element() {
return felement;
}
/**
+ * Return a Filter that matches any {@link Document} data.
+ *
* @return a Filter that matches any {@link Document} data.
*/
public static final Filter<Document> document() {
return fdocument;
}
/**
+ * Return a Filter that matches any {@link Element} data with the specified
+ * name.
+ *
* @param name The name of Elements to match.
* @return a Filter that matches any {@link Element} data with the specified
* name.
@@ -217,6 +245,9 @@ private Filters() {
}
/**
+ * Return a Filter that matches any {@link Element} data with the specified
+ * name and Namespace.
+ *
* @param name The name of Elements to match.
* @param ns The Namespace to match
* @return a Filter that matches any {@link Element} data with the specified
@@ -227,6 +258,9 @@ private Filters() {
}
/**
+ * Return a Filter that matches any {@link Element} data with the specified
+ * Namespace.
+ *
* @param ns The Namespace to match
* @return a Filter that matches any {@link Element} data with the specified
* Namespace.
@@ -236,13 +270,18 @@ private Filters() {
}
/**
+ * Return a Filter that matches any {@link ProcessingInstruction} data.
+ *
* @return a Filter that matches any {@link ProcessingInstruction} data.
*/
public static final Filter<ProcessingInstruction> processinginstruction() {
return fpi;
}
/**
+ * Return a Filter that matches any {@link Text} data (which includes
+ * {@link CDATA} since that is a subclass of Text).
+ *
* @return a Filter that matches any {@link Text} data (which includes
* {@link CDATA} since that is a subclass of Text).
*/
@@ -251,27 +290,35 @@ private Filters() {
}
/**
+ * Return a Filter that matches any Boolean data.
+ *
* @return a Filter that matches any Boolean data.
*/
public static final Filter<Boolean> fboolean() {
return fboolean;
}
/**
+ * Return a Filter that matches any String data.
+ *
* @return a Filter that matches any String data.
*/
public static final Filter<String> fstring() {
return fstring;
}
/**
+ * Return a Filter that matches any Double data.
+ *
* @return a Filter that matches any Double data.
*/
public static final Filter<Double> fdouble() {
return fdouble;
}
/**
+ * Return a Filter that matches any data of the specified Class.
+ *
* @param <F> The generic type of the content returned by this Filter
* @param clazz the Class type to match in the filter
* @return a Filter that matches any data of the specified Class.

0 comments on commit b7db151

Please sign in to comment.