Merge pull request #45 from javaee-security-spec/wmhopkins-pfd

wmhopkins · web-flow · commit cf8d7bd76fd9 · 2017-07-11T02:35:48.000-04:00
Javadoc tweaks
diff --git a/src/main/java/javax/security/enterprise/authentication/mechanism/http/BasicAuthenticationMechanismDefinition.java b/src/main/java/javax/security/enterprise/authentication/mechanism/http/BasicAuthenticationMechanismDefinition.java
@@ -60,9 +60,8 @@
     /**
      * Name of realm that will be sent via the <code>WWW-Authenticate</code> header.
      * <p>
-     * Note that contrary to what happens in some proprietary Servlet products, this
-     * realm name <b>does not</b> couple a named identity store configuration to the 
-     * authentication mechanism.  
+     * Note that this realm name <b>does not</b> couple a named identity store
+     * configuration to the authentication mechanism.
      * 
      * @return Name of realm
      */
diff --git a/src/main/java/javax/security/enterprise/identitystore/LdapIdentityStoreDefinition.java b/src/main/java/javax/security/enterprise/identitystore/LdapIdentityStoreDefinition.java
@@ -76,7 +76,7 @@ enum LdapSearchScope { ONE_LEVEL, SUBTREE }
      * @return URL where the LDAP server can be reached
      */
     String url() default "";
-    
+
     /**
      * Distinguished name for the application or administrative user that will be used to
      * make the initial connection to the LDAP and to perform searches and lookups.
@@ -99,7 +99,7 @@ enum LdapSearchScope { ONE_LEVEL, SUBTREE }
      * @return password for the application user.
      */
     String bindDnPassword() default "";
-    
+
     /**
      * Base distinguished name for callers in the LDAP store
      * (e.g., "<code>ou=caller,dc=jsr375,dc=net</code>").
@@ -199,7 +199,7 @@ enum LdapSearchScope { ONE_LEVEL, SUBTREE }
      * @return Search expression to find groups.
      */
     String groupSearchFilter() default "";
-    
+
     /**
      * Search scope for group searches, determines depth
      * of the search in the LDAP tree.
diff --git a/src/main/java/javax/security/enterprise/package-info.java b/src/main/java/javax/security/enterprise/package-info.java
@@ -48,8 +48,8 @@
  * 
  * <h3>...Definition annotations</h3>
  * 
- * The Java EE Security API features several annotations ending on <code>Definition</code> which when used make CDI
- * beans available. For completeness, this concerns the following annotations:
+ * The Java EE Security API features several annotations, with names that end with <code>Definition</code>,
+ * which, when used, make CDI beans available. For completeness, this concerns the following annotations:
  * 
  *  <ul>
  *  <li>{@link javax.security.enterprise.identitystore.DatabaseIdentityStoreDefinition}</li>
@@ -59,8 +59,8 @@
  *  <li>{@link javax.security.enterprise.authentication.mechanism.http.FormAuthenticationMechanismDefinition}</li>
  *  </ul>
  *  
- * For all attributes of type <code>String</code> on these annotations expression language 3.0 expressions can be used.  
- * All named CDI beans are available to that expression as well as the default classes as specified by EL 3.0 for the
+ * For all attributes of type <code>String</code> on these annotations, Expression Language 3.0 expressions can be used.
+ * All named CDI beans are available to that expression, as well as the default classes as specified by EL 3.0 for the
  * {@link ELProcessor}.
  * 
  * <p>
@@ -71,9 +71,9 @@
  * 
  * <p>
  * Attributes that are documented as being EL alternatives to non-<code>String</code> type
- * attributes (attributes of which the name ends on <code>Expression</code>, hereafter called EL alternative attribute) 
- * MUST evaluate to the same type as the attribute they are an alternative to. If the EL alternative attribute has a 
- * non empty value, it takes precedence over the attribute which it is an alternative to.  
+ * attributes (attributes for which the name ends with <code>Expression</code>, hereafter called EL alternative attribute)
+ * MUST evaluate to the same type as the attribute they are an alternative to. If the EL alternative attribute has a
+ * non empty value, it takes precedence over the attribute which it is an alternative to.
  * 
  * <p>
  * The EL alternative attribute MUST contain a valid EL expression. Attributes of type string that are not EL alternative

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,8 @@`
`48`	`48`	`*`
`49`	`49`	`* <h3>...Definition annotations</h3>`
`50`	`50`	`*`
`51`		`- * The Java EE Security API features several annotations ending on <code>Definition</code> which when used make CDI`
`52`		`- * beans available. For completeness, this concerns the following annotations:`
	`51`	`+ * The Java EE Security API features several annotations, with names that end with <code>Definition</code>,`
	`52`	`+ * which, when used, make CDI beans available. For completeness, this concerns the following annotations:`
`53`	`53`	`*`
`54`	`54`	`* <ul>`
`55`	`55`	`* <li>{@link javax.security.enterprise.identitystore.DatabaseIdentityStoreDefinition}</li>`
`@@ -59,8 +59,8 @@`
`59`	`59`	`* <li>{@link javax.security.enterprise.authentication.mechanism.http.FormAuthenticationMechanismDefinition}</li>`
`60`	`60`	`* </ul>`
`61`	`61`	`*`
`62`		`- * For all attributes of type <code>String</code> on these annotations expression language 3.0 expressions can be used.`
`63`		`- * All named CDI beans are available to that expression as well as the default classes as specified by EL 3.0 for the`
	`62`	`+ * For all attributes of type <code>String</code> on these annotations, Expression Language 3.0 expressions can be used.`
	`63`	`+ * All named CDI beans are available to that expression, as well as the default classes as specified by EL 3.0 for the`
`64`	`64`	`* {@link ELProcessor}.`
`65`	`65`	`*`
`66`	`66`	`* <p>`
`@@ -71,9 +71,9 @@`
`71`	`71`	`*`
`72`	`72`	`* <p>`
`73`	`73`	`* Attributes that are documented as being EL alternatives to non-<code>String</code> type`
`74`		`- * attributes (attributes of which the name ends on <code>Expression</code>, hereafter called EL alternative attribute)`
`75`		`- * MUST evaluate to the same type as the attribute they are an alternative to. If the EL alternative attribute has a`
`76`		`- * non empty value, it takes precedence over the attribute which it is an alternative to.`
	`74`	`+ * attributes (attributes for which the name ends with <code>Expression</code>, hereafter called EL alternative attribute)`
	`75`	`+ * MUST evaluate to the same type as the attribute they are an alternative to. If the EL alternative attribute has a`
	`76`	`+ * non empty value, it takes precedence over the attribute which it is an alternative to.`
`77`	`77`	`*`
`78`	`78`	`* <p>`
`79`	`79`	`* The EL alternative attribute MUST contain a valid EL expression. Attributes of type string that are not EL alternative`