Merge pull request #5115 from Emkas/javadoc-fixes

Various Javadoc fixes

impl/src/main/java/com/sun/faces/application/view/ViewScopeContextObject.java

@@ -35,7 +35,7 @@ class ViewScopeContextObject implements Serializable {
      * Constructor.
      *
      * @param passivationCapableId the return from PassivationCapable.getId().
-     * @param creationalContext the creational context.
+     * @param name name of context.
      */
     public ViewScopeContextObject(String passivationCapableId, String name) {
         this.passivationCapableId = passivationCapableId;

impl/src/main/java/com/sun/faces/facelets/impl/DefaultFacelet.java

@@ -113,7 +113,8 @@ public void applyMetadata(FacesContext facesContext, UIComponent parent) throws
     }
 
     /**
-     * @see com.sun.faces.facelets.Facelet#apply(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
+     * @see jakarta.faces.view.facelets.Facelet#apply(jakarta.faces.context.FacesContext,
+     *      jakarta.faces.component.UIComponent)
      */
     @Override
     public void apply(FacesContext facesContext, UIComponent parent) throws IOException {
@@ -300,7 +301,7 @@ public void include(DefaultFaceletContext ctx, UIComponent parent, String path)
     /**
      * Grabs a DefaultFacelet from referenced DefaultFaceletFacotry
      *
-     * @see DefaultFaceletFactory#getFacelet(URL)
+     * @see DefaultFaceletFactory#getFacelet(FacesContext,URL)
      * @param ctx FaceletContext to pass to the included Facelet
      * @param parent UIComponent to apply changes to
      * @param url URL source to include Facelet from

impl/src/main/java/com/sun/faces/facelets/tag/AbstractTagLibrary.java

@@ -145,7 +145,6 @@ public String getBehaviorId() {
          * <p class="changed_added_2_0">
          * </p>
          *
-         * @return
          * @see jakarta.faces.view.facelets.TagConfig#getNextHandler()
          */
         @Override
@@ -157,7 +156,6 @@ public FaceletHandler getNextHandler() {
          * <p class="changed_added_2_0">
          * </p>
          *
-         * @return
          * @see jakarta.faces.view.facelets.TagConfig#getTag()
          */
         @Override
@@ -169,7 +167,6 @@ public Tag getTag() {
          * <p class="changed_added_2_0">
          * </p>
          *
-         * @return
          * @see jakarta.faces.view.facelets.TagConfig#getTagId()
          */
         @Override

impl/src/main/java/jakarta/faces/FacesWrapper.java

@@ -24,7 +24,7 @@
  *
  * <p class="changed_added_2_3">
  * The expected usage of all subclasses is to provide a constructor that takes an instance of type <code>T</code>, which
- * sets the instance variable that is returned from the {@link getWrapped} method.
+ * sets the instance variable that is returned from the {@link #getWrapped} method.
  * </p>
  *
  * @param <T> the wrapped type.

impl/src/main/java/jakarta/faces/FactoryFinder.java

@@ -281,13 +281,13 @@ public static Object getFactory(String factoryName) throws FacesException {
      * This method can be used by implementations to store a factory mapping while parsing the Faces configuration file
      * </p>
      *
-     * @throws IllegalArgumentException if <code>factoryName</code> does not identify a standard Jakarta Faces
-     * factory name
-     * @throws NullPointerException if <code>factoryname</code> is null
-     *
      * @param factoryName the name to be used in a subsequent call to {@link #getFactory}.
      *
      * @param implName the fully qualified class name of the factory corresponding to {@code factoryName}.
+     *
+     * @throws IllegalArgumentException if <code>factoryName</code> does not identify a standard Jakarta Faces
+     * factory name
+     * @throws NullPointerException if <code>factoryname</code> is null
      */
     public static void setFactory(String factoryName, String implName) {
         FACTORIES_CACHE.getFactoryFinder().addFactory(factoryName, implName);

impl/src/main/java/jakarta/faces/application/Application.java

@@ -370,10 +370,11 @@ public ProjectStage getProjectStage() {
      * not breaking existing applications that extend {@link Application}.
      * </p>
      *
+     * @param resolver the Jakarta Expression Language resolver to add.
+     *
      * @throws IllegalStateException <span class="changed_modified_2_0_rev_a">if called after the first request to the
      * {@link jakarta.faces.webapp.FacesServlet} has been serviced.</span>
      *
-     * @param resolver the Jakarta Expression Language resolver to add.
      * @since 1.2
      */
     public void addELResolver(ELResolver resolver) {
@@ -1623,11 +1624,12 @@ public void setSearchExpressionHandler(SearchExpressionHandler searchExpressionH
      *
      * </div>
      *
+     * @param resolver the SearchKeywordResolver to add.
+     *
      * @throws IllegalStateException if called after the first request to the {@link jakarta.faces.webapp.FacesServlet} has
      * been serviced.
      * @throws NullPointerException when resolver is null.
      *
-     * @param resolver the SearchKeywordResolver to add.
      * @since 2.3
      */
     public void addSearchKeywordResolver(SearchKeywordResolver resolver) {

impl/src/main/java/jakarta/faces/application/ApplicationFactory.java

@@ -91,9 +91,9 @@ public ApplicationFactory getWrapped() {
      * Replace the {@link Application} instance that will be returned for this web application.
      * </p>
      *
-     * @throws NullPointerException if <code>application</code> is <code>null</code>.
-     *
      * @param application The replacement {@link Application} instance
+     *
+     * @throws NullPointerException if <code>application</code> is <code>null</code>.
      */
     public abstract void setApplication(Application application);
 

impl/src/main/java/jakarta/faces/component/ComponentStateHelper.java

@@ -161,7 +161,6 @@ private void initMap(Serializable key) {
      * enough.
      *
      * @param key
-     * @return
      */
     @Override
     public Object get(Serializable key) {

impl/src/main/java/jakarta/faces/component/UIViewRoot.java

@@ -1136,7 +1136,7 @@ public boolean getRendersChildren() {
      *
      * @param context the context for this request
      * @param phaseId the {@link PhaseId} of the current phase
-     * @param isBefore, if true, notify beforePhase listeners. Notify afterPhase listeners otherwise.
+     * @param isBefore if true, notify beforePhase listeners. Notify afterPhase listeners otherwise.
      */
     private void notifyPhaseListeners(FacesContext context, PhaseId phaseId, boolean isBefore) {
         PhaseEvent event = createPhaseEvent(context, phaseId);

impl/src/test/java/com/sun/faces/config/DigesterFactory.java

@@ -115,7 +115,6 @@ private DigesterFactory(boolean isValidating) {
      * <p>
      * Returns a new <code>DigesterFactory</code> instance that will create a
      * non-validating <code>Digester</code> instance.</p>
-     * @return 
      */
     public static DigesterFactory newInstance() {
         return DigesterFactory.newInstance(false);
@@ -178,7 +177,6 @@ public static void releaseDigester(Digester toRelease) {
      * <p>
      * Creates a new <code>Digester</code> instance configured for use with
      * Jakarta Faces.</p>
-     * @return 
      */
     public Digester createDigester() {
         Digester digester = new Digester();

impl/src/test/java/com/sun/faces/mock/MockApplication.java

@@ -526,7 +526,7 @@ public void publishEvent(FacesContext context,
      * jakarta.faces.event.SystemEventListener#processEvent} method must be called
      * when events of type <code>systemEventClass</code> are fired.
      *
-     * @throws <code>NullPointerException</code> if any combination of
+     * @throws NullPointerException if any combination of
      * <code>systemEventClass</code>, or <code>listener</code> are
      * <code>null</code>.
      *
@@ -566,7 +566,7 @@ public void subscribeToEvent(Class<? extends SystemEvent> systemEventClass,
      * jakarta.faces.event.SystemEventListener#processEvent} method must be called
      * when events of type <code>systemEventClass</code> are fired.
      *
-     * @throws <code>NullPointerException</code> if any combination of
+     * @throws NullPointerException if any combination of
      * <code>systemEventClass</code>, or <code>listener</code> are
      * <code>null</code>.
      *
@@ -600,7 +600,7 @@ public void subscribeToEvent(Class<? extends SystemEvent> systemEventClass,
      * jakarta.faces.event.SystemEventListener} to remove from the internal data
      * structure.
      *
-     * @throws <code>NullPointerException</code> if any combination of
+     * @throws NullPointerException if any combination of
      * <code>context</code>, <code>systemEventClass</code>, or
      * <code>listener</code> are <code>null</code>.
      */
@@ -639,7 +639,7 @@ public void unsubscribeFromEvent(Class<? extends SystemEvent> systemEventClass,
      * jakarta.faces.event.SystemEventListener} to remove from the internal data
      * structure.
      *
-     * @throws <code>NullPointerException</code> if any combination of
+     * @throws NullPointerException if any combination of
      * <code>context</code>, <code>systemEventClass</code>, or
      * <code>listener</code> are <code>null</code>.
      */

impl/src/test/java/com/sun/faces/xml/ParseXMLTestCase.java

@@ -52,7 +52,6 @@ public void setUp() throws Exception {
 
     /**
      * Return the tests included in this test suite.
-     * @return 
      */
     public static Test suite() {
         return (new TestSuite(ParseXMLTestCase.class));

impl/src/test/java/jakarta/faces/FactoryFinderTestCase.java

@@ -35,10 +35,6 @@
 import junit.framework.Test;
 import junit.framework.TestSuite;
 
-/**
- * <p>
- * Unit tests for {@link UISelectBooleanBase}.</p>
- */
 public class FactoryFinderTestCase extends TestCase {
 
     // ------------------------------------------------------------ Constructors

impl/src/test/java/jakarta/faces/FactoryFinderTestCase2.java

@@ -20,10 +20,6 @@
 import junit.framework.Test;
 import junit.framework.TestSuite;
 
-/**
- * <p>
- * Unit tests for {@link UISelectBooleanBase}.</p>
- */
 public class FactoryFinderTestCase2 extends TestCase {
 
     // ------------------------------------------------------------ Constructors

impl/src/test/java/jakarta/faces/component/UIComponentBaseBehaviorTestCase.java

@@ -189,7 +189,7 @@ public void testNonClientBehaviorHolder() throws Exception {
 
     /**
      * Test method for
-     * {@link jakarta.faces.component.UIComponentBase#addClientBehavior(java.lang.String, jakarta.faces.component.behavior.Behavior)}.
+     * {@link jakarta.faces.component.UIComponentBase#addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior)}.
      */
     public void testAddBehavior() {
         BehaviorComponent comp = new BehaviorComponent();

impl/src/test/java/jakarta/faces/component/UIViewRootTestCase.java

@@ -57,8 +57,6 @@ public UIViewRootTestCase(String name) {
     // ---------------------------------------------------- Overall Test Methods
     /**
      * Return the tests included in this test suite.
-     *
-     * @return
      */
     public static Test suite() {
         return new TestSuite(UIViewRootTestCase.class);

impl/src/test/java/jakarta/faces/webapp/ConfigFileTestCase.java

@@ -70,8 +70,6 @@ public void setUp() throws Exception {
 
     /**
      * Return the tests included in this test suite.
-     *
-     * @return
      */
     public static Test suite() {
         return (new TestSuite(ConfigFileTestCase.class));