I agree.
If it offends you to see them in the generated javadoc, I would
"comment them out" in some way so as not to lose them and be able to
add them in later as appropriate. But just leaving them in now is
easier.
Kevin Sutter wrote on 7/30/19 10:12 AM:
Personally, I
would
leave these references as-is. Yes, they still reference the
original
Java EE Specs. But, many of these standalone Specs will
eventually
become part of Jakarta (cross your fingers). Post Jakarta EE 8,
these
could be updated accordingly. That's how I would approach these
situations.
---------------------------------------------------
Kevin Sutter
STSM, MicroProfile and Jakarta EE architect
e-mail: sutter@xxxxxxxxxx Twitter: @kwsutter
phone: tl-553-3620 (office), 507-253-3620 (office)
LinkedIn: https://www.linkedin.com/in/kevinwsutter
From:
arjan
tijms <arjan.tijms@xxxxxxxxx>
To:
"jakarta.ee-spec.committee@xxxxxxxxxxx"
<jakarta.ee-spec.committee@xxxxxxxxxxx>
Cc:
JakartaEE
Spec Project Leadership discussions
<jakartaee-spec-project-leads@xxxxxxxxxxx>
Date:
07/30/2019
11:46 AM
Subject:
[EXTERNAL]
Re: [jakartaee-spec-project-leads] References to spec sections
Sent
by: jakartaee-spec-project-leads-bounces@xxxxxxxxxxx
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
_______________________________________________
jakartaee-spec-project-leads mailing list
jakartaee-spec-project-leads@xxxxxxxxxxx
To change your delivery options, retrieve your password, or
unsubscribe
from this list, visit
https://dev.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
_______________________________________________
jakarta.ee-spec.committee mailing list
jakarta.ee-spec.committee@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee
|