[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
AW: [platform-ui-dev] RE: [jdt-ui-dev] Hyperlinked code feature in M3
|
Yes, the Javadoc generation wizard is too burried and it's not logical to
search for this under the export menu. The first time I used Eclipse it took
me 15 minutes to find out where the hell and how the javadoc generation can
be forced by the IDE. You better place this one as an submenu entry under
one "Wizards" or "Tools" main menu entry or the like.
Where we are on the javadoc theme, most support of that and it's possible
customizations are actually pretty half harted done. Some examples might
better explain here what I mean with "half harted done":
1. Eclipse when installed, right out of the box should offer full access via
the help system to it's own javadoc documented API classes. I mean here a
Shift-F2 on some SWT, JFace etc. class, method, field and so on... should
pop up the full relevant javadoc entries for these. The user shouldn't have
to set up these explicitely or just to live with fragmented portions of
hover popups.
2. The access to the standard Java JDK javadocs should be eased and it
should be possible to access these from inside of zipped/jarred archives.
Nobody want's to install ~125 MB of extracted HTML files, were in contrast a
zipped archive of that occupies only ~30 MB disk space. - Even it is
actually possible (see my Eclipse Wiki entry under the JDT section...) to
handle this, it is more complicated to do this for Eclipse newcomers, since
they actually have to fix port numbers and use some plugin for the archived
JDK docs access. - Eclipse should offer access to both, it's own javadocs
and those of the underlayed/used Java JDK in an easy to handle and setup
manner.
3. The hover javadoc popups inside the java editor only show a short broken
fraction of the whole javadoc. The information shown there often doesn't
show enough of the javadoc explanation for the selected elements. Further
this popup actually isn't scrollable, so that it possibly could show more of
the javadoc contents related to an selected element, if it would be
scollable (?).
4. Many things inside the Eclipse APIs aren't javadoc documented at all, or
lack absolutely some well descripting documention here. Thus many things
there look like quick hacked together code, instead of thouroughly thought
out concepts. At least the missing docs give users these impressions. So
it's generally difficult for people to understand what certain API classes,
methods... are good for at all. A prove for this might be here the big
traffics in the newsgroups. If things would be better documented and clearer
they wouldn't have to ask so much there on how to do this or that. - Compare
the degree of Sun JDK javadocs to those for the Eclipse APIs and you will
see what I mean.
I hope you will also spend some efforts on the above mentioned topics, since
these are also very important for the general success and acceptance of
Eclipse.
-Valentino
> -----Ursprungliche Nachricht-----
> Von: jdt-ui-dev-admin@xxxxxxxxxxx
> [mailto:jdt-ui-dev-admin@xxxxxxxxxxx]Im Auftrag von Erich Gamma
> Gesendet: Donnerstag, 21. November 2002 22:35
> An: jdt-ui-dev@xxxxxxxxxxx
> Cc: jdt-ui-dev@xxxxxxxxxxx; platform-ui-dev@xxxxxxxxxxx
> Betreff: Re: [platform-ui-dev] RE: [jdt-ui-dev] Hyperlinked code feature
> in M3
>
>
>
> Scott raised the issue that it was difficult for him to find the generate
> Java Doc support. Here are the options we considered when
> finding a home for this action:
>
> 1) export wizard
> We are using the "export" extension point for generating JARs.
> Generating javadoc is a similar process: you run a tool that processes the
> contents
> in the workspace that generates results outside (sometimes inside) of the
> workspace.
> Therefore generate javadoc can fit into export.
>
> Scott - why didn't you have any problems to locate the JAR exporting
> inside the export wizard (was it because VA/Java users are used to it)?
>
> 2) Tools menu
> Add a top level "Tools" menu and add the generation actions like
> generate JAR, generate Java Doc to this menu. The issue
> with a Tools menu is that it can easily become a kitchen sink and be
> misused. If there is a Tools menu, then it should
> be standardized by the workbench. For the above reasons we
> didn't even start this discussion with the workbench.
>
> 3) Source menu
> Put the generate javadoc action into the Source menu.
> This stretches the purpose of the Source menu. We
> created it for source manipulation actions.
>
> Given the above options we have decided for 1).
>
> Sebastion proposed below to turn the Export action into
> a similar action as New with a submenu. This enables
> to find exporters by scanning the menus. It is not clear to me
> how well this would scale since many exporters are
> not perspective specific.
>
> --erich
>
>
>
>
>
> "Nick Edgar"
>
> <Nick_Edgar@oti.c To:
> platform-ui-dev@xxxxxxxxxxx, jdt-ui-dev@xxxxxxxxxxx
> om> cc:
>
> Sent by: Subject: Re:
> [platform-ui-dev] RE: [jdt-ui-dev] Hyperlinked code feature in
> jdt-ui-dev-admin@ M3
>
> eclipse.org
>
>
>
>
>
> 11/21/2002 09:08
>
> PM
>
> Please respond to
>
> jdt-ui-dev
>
>
>
>
>
>
> I think the complaint was that "Export" wasn't intuitive for javadoc
> generation to begin with.
> This is really a JDT issue.
>
> Nick
>
>
>
>
>
> Sebastian Davids <sdavids@xxxxxx>
> Sent by: platform-ui-dev-admin@xxxxxxxxxxx
> 11/21/02 01:30 PM
> Please respond to platform-ui-dev
>
>
> To: platform-ui-dev@xxxxxxxxxxx
> cc:
> Subject: Re: [platform-ui-dev] RE: [jdt-ui-dev] Hyperlinked
> code feature in M3
>
>
> >>Now if we could just put javadoc generation someplace intuitive --
> took me
> >>forever to find it under "export" -- then the UI would be nearly
> perfect ;)
>
> I second this.
>
> I'd opt for a similar style (second level menu) we have w/ "New".
>
> Export >
> File System
> JAR-File
> Javadoc
> Other...
>
> On folders/projects/packages w/out "*.java"-files the menu option
> Export/Javadoc would have to be disabled -- generating Javadoc for
> classes w/ no javadoc comments in source code is OK.
>
> Sebastian Davids
>
> P.S.: I'd try to implement this if you want me to.
>
>
> _______________________________________________
> platform-ui-dev mailing list
> platform-ui-dev@xxxxxxxxxxx
> http://dev.eclipse.org/mailman/listinfo/platform-ui-dev
>
>
>
> _______________________________________________
> jdt-ui-dev mailing list
> jdt-ui-dev@xxxxxxxxxxx
> http://dev.eclipse.org/mailman/listinfo/jdt-ui-dev
>
>
>
> _______________________________________________
> jdt-ui-dev mailing list
> jdt-ui-dev@xxxxxxxxxxx
> http://dev.eclipse.org/mailman/listinfo/jdt-ui-dev
>
