This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 21445 - better What's new document
Summary: better What's new document
Status: CLOSED FIXED
Alias: None
Product: usersguide
Classification: Unclassified
Component: Code (show other bugs)
Version: 3.x
Hardware: All All
: P4 blocker (vote)
Assignee: issues@usersguide
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2002-03-11 21:25 UTC by vbrabant
Modified: 2003-07-01 15:24 UTC (History)
2 users (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments
copy of my help screen (137.22 KB, image/jpeg)
2002-03-12 08:31 UTC, vbrabant
Details

Note You need to log in before you can comment on or make changes to this bug.
Description vbrabant 2002-03-11 21:25:04 UTC
I would
like to have a better what's new document.

In NB 3.3.1 I found no many lines about Annotations.
Annotation is one of the big news in NB 3.3.1.

"Annotations (aka Glyphs) Annotations is a method to highlight a part of
text of the document. The text is highlighted either by special background
color or by putting an icon on the gutter or both."

It's a little light for explaination, don't you ?

I think it can be usefull to introduce in the change.html one or more links
to online help pages to have more details. More explaination.
It will be useful for someone that want to have more informations.


Also, Can someone explain me what is the 'Call Site' annotation. I have
founded no explanation about that. No idea what it means.
Comment 1 Patrick Keegan 2002-03-11 21:54:53 UTC
Frankly, the Changes.html document will probably remain fairly undetailed, since most of our 
documentation effort goes into getting the online help into shape. I'll leave this open as a p5, however. 
BTW, there will be an update to the online help for NB 3.3.1 some time in the next few months, so look 
forward to that. 

I'm not sure what the Call Site annotation refers to either. Gail, could you provide a quick note?

For now, I don't think it's possible to link to the online help (which lives in a JAR file) from the 
Changes.html file. Also, it's not that practical, since the structure of the help might change between 
the release and any updates.
Comment 2 Brenda Bowden 2002-03-12 00:10:54 UTC
While this doesn't address the What's New page, you can find the
following info about annotations in the Core IDE helpset of the
online help.  (See Help->Help Sets->Core IDE Help.)  I found these
pages using the Help system Search mechanism.

For general info on using annotations, see Editing Source Files
-> Using Annotations.

For general info on the annotation properties, see Editing Source
Files -> Configuring the Source Editor -> Annotation Properties.

For info on the debugger annotation types, see Debugging Java 
Programs -> The Debug Environment -> Debugger Interactions With the
Source Editor.   This page describes call site as, "The place in the
source code from which a method on the call stack was called."

I'll be adding a link from the Source Editor annotation pages to the
Debugger annotation page, but this won't show up in the development
builds until the update Patrick referenced in his previous comment.

The debugger annotation page should probably add similar cross
references to the annotation pages in the Source Editor section.
Comment 3 vbrabant 2002-03-12 08:23:44 UTC
Within NB331 I searched about 'Call Site' and nothing linked to call 
site was founded.
I searched about annotation and I never found a link to debugger.

You say 
"For info on the debugger annotation types, see Debugging Java 
Programs -> The Debug Environment -> Debugger Interactions With the
Source Editor.   This page describes call site as, "The place in the
source code from which a method on the call stack was called."
"
But I am very very sorry. I don't have that shortcut.
I have set a copy of my screen in attach. I hope that it can help you.
Maybe this is available in the daily version of Netbeans, but not in 
the 3.3.1
Comment 4 vbrabant 2002-03-12 08:31:35 UTC
Created attachment 5026 [details]
copy of my help screen
Comment 5 vbrabant 2002-03-12 08:53:22 UTC
After searching more details, I founded a legend of icons for 
annotation.
But, never the words 'Annotation' 'Glyph' or 'Call Site' are written 
there.

I have no idea with which words you have done your research. But 
with 'debugger annotation type', I find pages explaining annotation, 
or debugger type. But never I see the page with legend of debugger 
annotation type.

I think that all the stuff is well documented, but it's the problem 
to retrieve it with the searching module. That is a question of 
vocabulary.

For example, in the 'Debugging Java Programs => The debug 
environment' node, I find a section 'Source Editor' with a table 
containing symbol and description.
In that section, I never founded the words 'Annotation', or 'Glyph' 
or 'Call Site'.
I have to guess that the blue triangle is the symbol for the 'Call 
Site' and that description "The place in the source code from which a 
method on the call stack was called" is the description of the 'Call 
Site'.
I am sorry, but I can't devine that.
And when I am searching about 'annotation' or 'glyph' or 'Call Site', 
this page is NEVER proposed. And THAT IS THE PROBLEM.
Comment 6 Gail Chappell 2002-03-12 19:18:55 UTC
Thank you for pointing out the problem.  I have added the terminology
you suggested (annotation and call site) to the debugging section. 
You will be able to see the updates in tomorrow's Netbeans 3.3.1
build.
Comment 7 Quality Engineering 2003-07-01 15:21:10 UTC
Resolved for 3.4.x or earlier, no new info since then -> closing.
Comment 8 Quality Engineering 2003-07-01 15:24:30 UTC
Resolved for 3.4.x or earlier, no new info since then -> closing.