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 48984 - Streamline the user flow of adding Javadoc and sources for a jar file
Summary: Streamline the user flow of adding Javadoc and sources for a jar file
Status: RESOLVED FIXED
Alias: None
Product: projects
Classification: Unclassified
Component: Libraries (show other bugs)
Version: 4.x
Hardware: All All
: P3 blocker with 1 vote (vote)
Assignee: Jan Jancura
URL: http://projects.netbeans.org/nonav/bu...
Keywords: UI
: 51452 (view as bug list)
Depends on:
Blocks: 41535
  Show dependency tree
 
Reported: 2004-09-14 09:15 UTC by Petr Jiricka
Modified: 2009-07-29 15:29 UTC (History)
2 users (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Petr Jiricka 2004-09-14 09:15:38 UTC
See also issue 47498. Imagine the following situation:

1. User adds a jar file to a project classpath
2. Later she realizes that she also has Javadoc or
sources for this jar file.
3. To register it, she needs to define a library,
specify the original jar file and only then she is
allowed to specify the sources/Javadoc.

This scenario should be streamlined, so fewer user
steps are requires, and so adding Javadoc/sources
is more intuitive.
Comment 1 Jesse Glick 2004-11-12 19:49:51 UTC
*** Issue 51452 has been marked as a duplicate of this issue. ***
Comment 2 _ mihmax 2004-11-14 11:44:29 UTC
my 2 cents here:
> Milan Kubec 2004-11-12 04:13 PST
> Why whould you prefer adding only jar file to comp. cp. 
> of the project and then adding javadoc separatelly to
> creating library

Just as written here earlier, it's not very obvious that I have to 
1) remove jar, 
2) create library, 
   a) add jar to library, 
   b) add javadoc to library, 
3) add library

And take freeform project (recreated from Ant script) for example,
that uses something about 10 libraries.
It's 50 clicks currently!
(vs. 10 clicks to add 10 javadocs)
Comment 3 _ mihmax 2004-11-14 11:51:55 UTC
Also imagine using the same library in two projects:

pro_one
|-lib
| |-foolib.jar
|-src

pro_two
|-lib
| |-foolib.jar
|-src

So what library should I add using Library Manager?
And if I add the jar from project pro_one, then sharing project
pro_two becomes impossible!
Comment 4 Jesse Glick 2004-12-01 19:36:07 UTC
Maxym a UI spec is already being written which should address the most
common problems.
Comment 5 _ mihmax 2004-12-01 19:45:40 UTC
Thanks for good news, Jesse.
How can I participate in refining the spec?
Comment 6 Jesse Glick 2004-12-01 19:47:30 UTC
Sure... Jano was just about to publish it on projects.netbeans.org I
think?
Comment 7 _ mihmax 2004-12-01 19:54:19 UTC
Sorry, but I can't find it.
Is it me plain blind, or it wasn't just published yet?

If second holds, then Jano, please update this issue when you publish
UI Spec
Comment 8 jrojcek 2004-12-02 09:41:16 UTC
The UI spec is online:
http://projects.netbeans.org/nonav/buildsys/j2se-project-ui-spec-promoe.html
Comment 9 jrojcek 2004-12-08 17:11:53 UTC
The spec is in the URL field.
Comment 10 _ mihmax 2004-12-08 19:24:04 UTC
Jan, thanks a lot for publishing.
However it's not clear when this dialog appears:
http://projects.netbeans.org/nonav/buildsys/j2se-project-ui-spec-promoe.html#Libraries
has no reference or button that is to call the described dialog
Comment 11 _ mihmax 2004-12-08 19:27:25 UTC
Oh! Sorry, I found it - it's the Edit button on Libraries tab.
IMHO the name is not clear enough.

I'd propose "Source/Javadoc" or longer "Library's Source/Javadoc",
"Associate Source/Javadoc". Because it's basically what this button does
Comment 12 jrojcek 2004-12-09 13:28:47 UTC
I agree that the button name is a problem. I've considered different names but I don't want 
the buttons to be very long. If it appears to be a very big problem, I am willing to change 
the name. Also, please note that in case of a composed library (containing multiple JARs) 
this button allows to edit the library contents - JARs, sources and javadoc.

Another solution is to indicate those items in the libraries list that don't have javadoc and/
or sources associated. Something like:

Libraries:
-----------------
JUnit
xerces.jar (no javadoc) (no sources)
-----------------

This might give the user a clue that the Edit button would allow him to fix the missing 
sources and javadoc for "xerces.jar".
Comment 13 _ mihmax 2004-12-10 18:27:08 UTC
I see you point Jan,
maybe I'm not an appropriate man to discuss shortening labels, because
Russian labels are generally longer ;-)

But still "Add JAR/Folder..." has 18 symbols, and "Sources/Javadoc" -
only 15, and "JARs/Sources/Javadoc" - 20. However last label is too
dense, so it should be "JARs / Sources / Javadoc", which is 24
symbols. Long, you are 100% right.

Also I think it's undesirable to write "(no source) (no javadoc)" etc,
because that:
1. makes no connection to Edit... button, users have to guess anyway
2. wastes too much real width estate

However I'm thinking of an alternative solution - inline hint, just
like "RT Only - select if ..." is talking on "RT" switch, another
always visible online hint at the bottom, smth. like "Edit allows you
to add Sources and Javadoc for your libraries"
Comment 14 Petr Jiricka 2009-05-14 11:48:42 UTC
This is now fixed, right?
Comment 15 Petr Dvorak 2009-07-29 15:29:34 UTC
Yes, this seems to be fixed (click Edit button in the Libraries pane in the project properties).

=> FIXED