Bug 366015 - More F1 help needed for Null analysis preference page
Summary: More F1 help needed for Null analysis preference page
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 3.8   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 3.8 RC4   Edit
Assignee: Markus Keller CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on: 366014
Blocks:
  Show dependency tree
 
Reported: 2011-12-08 07:12 EST by Dani Megert CLA
Modified: 2012-06-07 10:25 EDT (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2011-12-08 07:12:57 EST
I20111207-2118.


The 'Null analysis' preference page's F1 help explains the new options but there needs to be more doc about this, especially how one needs to set this up.
Comment 1 Stephan Herrmann CLA 2012-06-05 10:39:49 EDT
I'm currently doing the final polish on the N&N entry for null annotations
and can't seem to find any help how to add the annotations jar to a project
as of yet.

Is this bug going to deliver that documentation?

I would like to link that section also from 
    tasks/task-using_null_annotations.htm
Comment 2 Markus Keller CLA 2012-06-05 11:42:59 EDT
I didn't have a concrete plan yet, and I don't think there's any doc about setup yet.

Could we add this right into task-using_null_annotations.htm?
The text would tell:
- where the annotation.jar is (eclipse/plugins/org.eclipse.jdt.annotation_*.jar)
- that the annotation.jar needs to be on the build path at compile time but is not necessary at run time
- that there are 2 quick fixes on unresolved references to one of the annotations:
  - for OSGi bundles, the annotations jar is added to the build path
  - for plain Java projects, the jar is copied into the project and added to the build path

I can do that if you're not working on task-using_null_annotations.htm (or just tell me when you're done or if I should just add screenshots of the quick fixes).
Comment 3 Stephan Herrmann CLA 2012-06-05 12:12:23 EDT
(In reply to comment #2)
> Could we add this right into task-using_null_annotations.htm?
> The text would tell:
> - where the annotation.jar is
> (eclipse/plugins/org.eclipse.jdt.annotation_*.jar)
> - that the annotation.jar needs to be on the build path at compile time but is
> not necessary at run time
> - that there are 2 quick fixes on unresolved references to one of the
> annotations:
>   - for OSGi bundles, the annotations jar is added to the build path
>   - for plain Java projects, the jar is copied into the project and added to
> the build path

sound good.
 
> I can do that if you're not working on task-using_null_annotations.htm (or just
> tell me when you're done or if I should just add screenshots of the quick
> fixes).

please go ahead. I don't have any further plans editing that page.
Comment 5 Stephan Herrmann CLA 2012-06-05 16:44:40 EDT
Looks good.

I just added the new section to the toc (to be consistent with other sections on this page).

Pushed with commit b68524acefa12e0cf4d44d87c8149b1b050b74bd.

Hope this will be picked up into integration by someone?