Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jakartaee-spec-project-leads] References to spec sections

p.s.

The same question for "simple" reference such as in the following text (there are quite an amount of those in the JSF Javadoc):

   /**

     * <p>

     * <span class="changed_modified_2_0_rev_a">Cause</span> an the argument <code>resolver</code>

     * to be added to the resolver chain as specified in section JSF.5.5.1 of the JavaServer Faces

     * Specification.


On Tue, Jul 30, 2019 at 3:35 PM arjan tijms <arjan.tijms@xxxxxxxxx> wrote:
Hi,

I was wondering what I should do about text like this in the Mojarra / Server Faces project:

/**
         * <p class="changed_added_2_3">This value indicates CDI should be used
         * for Jakarta _expression_ Language resolution as well as enabling Jakarta Server Faces CDI injection, as specified
         * in Section 5.6.3 "CDI for EL Resolution" and Section 5.9 "CDI Integration".</p>
         */
        JSF_2_3

The section itself refers to a section which is currently not there in the Jakarta Server Faces spec (and may well never be there), but the reference also contains the abbreviation that is to be replaced. After replacing it, it won't refer to any existing section title.

I'm inclined to just remove the reference, so it becomes:

/**
         * <p class="changed_added_2_3">This value indicates CDI should be used
         * for Jakarta _expression_ Language resolution as well as enabling Jakarta Server Faces CDI injection.</p>
         */
        JSF_2_3

Thoughts?

Kind regards,
Arjan


Back to the top