Skip to main content

[jsr362-experts:] Re: [jsr362-observers:] Color coding JavaDoc changes

  • From: Edward Burns < >
  • To:
  • Subject: [jsr362-experts:] Re: [jsr362-observers:] Color coding JavaDoc changes
  • Date: Wed, 7 Aug 2013 07:12:35 -0700

>>>>> On Tue, 6 Aug 2013 10:09:04 -0400, Kito Mann 
>>>>> < >
>>>>>  said:

KM> I think this an excellent idea. I don't think there are any legal
KM> restrictions, and I think Ed (who came up with that scheme) would like to
KM> see others adopt it. Ed?

Yes, indeed I would like to see the scheme get more widespread use.

It's rather labor intensive though. I had written it up in our FAQ [1].

Take a look at javax.faces.FactoryFinder [2] to see it in action.

In there, you'll see css classes used as shown here:

<strong class="changed_modified_2_0 changed_modified_2_1
changed_modified_2_2">FactoryFinder</strong>

This is an example of a "first word" attribution, and it indicates that
FactoryFinder was modified in 2.0, 2.1, and 2.2.  Later in the same
class, we see:

    /**
     * <p class="changed_added_2_2">The property name for the
     * {@link javax.faces.context.FlashFactory} class name.</p>
     * 
     * @since 2.2
     */
    public final static String FLASH_FACTORY =
         "javax.faces.context.FlashFactory";

This indicates this static field was added (by Mr. Griffin as it
happens) in 2.2.  All this stuff is done by including a CSS file with
the javadoc invocation.

Scott, it may be easiest to grant me write access to the svn repo and I
can create a branch that does it.  My java.net id is edburns.  If you're
amenable to this approach, send me a separate email with the svn URL
once you've granted me access, then I can get it set up and let you have
at it.  I'll leave it to someone else to generate the necessary image
files for the mouse hover cursor indicators.  Those were a pain to
generate, but they do look nice.

It's good to do it now early in the spec process so we won't have to do
much retroactive application of the CSS tags.

Ed

[1] 
https://wikis.oracle.com/display/GlassFish/JavaServerFacesRI#JavaServerFacesRI-HowdoImakesurethatchangestothespechavethecorrectversionchangebarattributions%3F

[2] 
https://maven.java.net/service/local/repositories/releases/archive/javax/faces/javax.faces-api/2.2/javax.faces-api-2.2-sources.jar/!/javax/faces/FactoryFinder.java




[jsr362-experts:] Color coding JavaDoc changes

Neil Griffin 08/05/2013

[jsr362-experts:] Re: [jsr362-observers:] Color coding JavaDoc changes

Martin Scott Nicklous 08/06/2013

[jsr362-experts:] Re: [jsr362-observers:] Color coding JavaDoc changes

Kito Mann 08/06/2013

[jsr362-experts:] Re: [jsr362-observers:] Color coding JavaDoc changes

Edward Burns 08/07/2013

[jsr362-experts:] Re: [jsr362-observers:] Color coding JavaDoc changes

Edward Burns 08/07/2013

[jsr362-experts:] Re: [jsr362-observers:] Color coding JavaDoc changes

Werner Keil 08/07/2013

[jsr362-experts:] Re: [jsr362-observers:] Color coding JavaDoc changes

Werner Keil 08/07/2013

[jsr362-experts:] Re: [jsr362-observers:] Re: Color coding JavaDoc changes

Martin Scott Nicklous 08/08/2013

[jsr362-experts:] Re: [jsr362-observers:] Re: Color coding JavaDoc changes

Werner Keil 08/08/2013

[jsr362-experts:] Re: [jsr362-observers:] Re: Color coding JavaDoc changes

Edward Burns 08/13/2013

[jsr362-experts:] Re: [jsr362-observers:] Re: Color coding JavaDoc changes

Werner Keil 08/13/2013
 
 
Close
loading
Please Confirm
Close