Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 385540 - Incorrect javadoc for @NonNullByDefault
Summary: Incorrect javadoc for @NonNullByDefault
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.8   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: 3.8.1   Edit
Assignee: Ayushman Jain CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-07-19 13:59 EDT by Deepak Azad CLA
Modified: 2012-08-14 04:32 EDT (History)
6 users (show)

See Also:
stephan.herrmann: review+


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Deepak Azad CLA 2012-07-19 13:59:22 EDT
Javadoc for @NonNullByDefault refers to 'project-wide default setting' which is no longer correct

http://help.eclipse.org/juno/index.jsp?topic=/org.eclipse.jdt.doc.isv/reference/api/org/eclipse/jdt/annotation/NonNullByDefault.html

A user asked a question on this here - http://stackoverflow.com/questions/11566341/nonnullbydefault-project-wide-setting
Comment 1 Ayushman Jain CLA 2012-07-19 15:19:10 EDT
Released in master via commit 978a0dbc1e2d585e90452a3aac1e4e70ac05dad2
Comment 2 Ayushman Jain CLA 2012-07-19 15:20:04 EDT
Stephan, I think this should be backported to 3.8.1 as well. Please eyeball the change and +1.
Comment 3 Stephan Herrmann CLA 2012-07-19 15:51:24 EDT
Change looks good, but I still see one occurrence:
/org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-errors-warnings.htm

Should we fix it via the same bug?
Comment 4 Ayushman Jain CLA 2012-07-20 01:44:36 EDT
(In reply to comment #3)
> Change looks good, but I still see one occurrence:
> /org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-errors-warnings.htm
> 
> Should we fix it via the same bug?

Oops I missed this. Fixed via http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=2eaee86c72f78e2c71630eb8807c2ef7cde84dfe in master.
Comment 5 Stephan Herrmann CLA 2012-07-20 07:02:06 EDT
Looks good & complete now, thanks.
+1 for backporting to 3.8.1.
Comment 6 Ayushman Jain CLA 2012-07-20 07:58:13 EDT
For 3.8.1, I've pushed the change to gerrit via https://git.eclipse.org/r/#/c/6892/ and marked Stephan as reviewer. Stephan, please +2 for release into R3_8_maintenance
Comment 7 Ayushman Jain CLA 2012-07-20 07:59:31 EDT
(In reply to comment #5)
> Looks good & complete now, thanks.
> +1 for backporting to 3.8.1.

I actually pushed to gerrit before I saw this comment. Anyway, your +2 there will auto-release the patch. Will also be a gerrit practice exercise for you ;)
Comment 8 Ayushman Jain CLA 2012-07-20 08:18:29 EDT
Released jdt.core patch in R3_8_maintenance via http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/commit/?h=R3_8_maintenance&id=582bc933207dd5993c4f5677036ca6833f164aa2
Comment 9 Ayushman Jain CLA 2012-07-20 08:24:40 EDT
(In reply to comment #4)
> (In reply to comment #3)
> > Change looks good, but I still see one occurrence:
> > /org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-errors-warnings.htm
> > 
> > Should we fix it via the same bug?
> 
> Oops I missed this. Fixed via
> http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=2eaee86c72f78e2c71630eb8807c2ef7cde84dfe
> in master.

Looks like there's no maintenance branch for o.e.platform.common repo. Whom should I file a bug against? And will the maintenance branch be called 3_8_m or 4_2_m? :\
Comment 10 Deepak Azad CLA 2012-07-20 09:19:23 EDT
(In reply to comment #9)
> Looks like there's no maintenance branch for o.e.platform.common repo. Whom
> should I file a bug against? And will the maintenance branch be called 3_8_m or
> 4_2_m? :\

I think committers with shell access can create a branch. Marcus?
Comment 11 Markus Keller CLA 2012-07-26 09:09:04 EDT
(In reply to comment #9)
> Looks like there's no maintenance branch for o.e.platform.common repo. Whom
> should I file a bug against? And will the maintenance branch be called 3_8_m or
> 4_2_m? :\

This problem is best solved through patience ;-). David has created both branches (bug 383704), and I've fixed the version numbers for those bundles which generate Javadoc API with http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=a81dba2fdc93c78c5b0462d27478b5b8019251d4
and http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=6e7bd6b29661f456ffb9c163410f52bee7e4fb80

I've also cherry-picked comment 4 in both branches:
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=9f9f8eeed2f709abd58af040500d7cdcfa6bb5ee
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=eebe5312e5e0ea007e2c24630b328fb9ad5a67ae

Declaring as Fixed in all three branches.
Comment 12 Srikanth Sankaran CLA 2012-08-06 03:05:14 EDT
Deepak, as of build id Build id: I20120805-2000, I still see
the old text - is this because of a build input issue with the
doc projects ? Thanks for looking into this.
Comment 13 Deepak Azad CLA 2012-08-06 04:53:19 EDT
(In reply to comment #12)
> is this because of a build input issue with the
> doc projects ? 

Should not be as the doc bundles are now built from tip of master. Markus?
Comment 14 Srikanth Sankaran CLA 2012-08-06 05:09:22 EDT
(In reply to comment #13)
> (In reply to comment #12)
> > is this because of a build input issue with the
> > doc projects ? 
> 
> Should not be as the doc bundles are now built from tip of master. Markus?

This looks like an operator error on my side - I don't now what exactly
happened. Double checking.
Comment 15 Srikanth Sankaran CLA 2012-08-06 05:14:54 EDT
Verified for 4.3 M1 using Build id: I20120805-2000
Comment 16 Markus Keller CLA 2012-08-06 06:14:58 EDT
The eclipse.platform.common repo is indeed auto-tagging now in all branches, see the respective /org.eclipse.releng/tagging/repositories.txt in the eclipse.platform.releng.maps repo.

However, the auto-tagging scripts only trigger re-generation of Javadocs if any file in the *.doc.isv bundle actually changed.

=> Just releasing a Javadoc update is not enough to make sure it shows up in the built Javadoc. You also have to touch any file in the *doc.isv bundle (e.g. aaa-how-to-add-things.txt if there's nothing else to do). See bug 366287.
Comment 17 Ayushman Jain CLA 2012-08-06 06:39:01 EDT
(In reply to comment #16)
> The eclipse.platform.common repo is indeed auto-tagging now in all branches,
> see the respective /org.eclipse.releng/tagging/repositories.txt in the
> eclipse.platform.releng.maps repo.
> 
> However, the auto-tagging scripts only trigger re-generation of Javadocs if
> any file in the *.doc.isv bundle actually changed.
> 
> => Just releasing a Javadoc update is not enough to make sure it shows up in
> the built Javadoc. You also have to touch any file in the *doc.isv bundle
> (e.g. aaa-how-to-add-things.txt if there's nothing else to do). See bug
> 366287.

Thanks for the info Markus, this had completely slipped out of my mind!
Comment 18 Tomasz Zarna CLA 2012-08-14 04:32:59 EDT
Verified in M20120809-1200 (4.2.1).