Home > Archive > Java Help > March 2006 > Javadoc search tool ... is this new ???
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Javadoc search tool ... is this new ???
|
|
| eferreyra 2006-03-28, 7:04 pm |
| Hi we are starting to implement java and one thing i think will be more
simple is the search in javadoc html files...
Now im surfing on internet and the only tools i find have broken links
or are commercial...
We need to respond to questions like:
"Where is the class for the Product Picker..?"
"How is called the method for the interesrt calculation..."
"etc. etc"
I think if we have quality javadocs the problem was solved, but now i
cant find some nice way to search in the javadocs...
Can you tell me how you are resolving this ?
There are good javadoc search tools ?
Do you use some other intranet search tool ?
Thanks !!
AUS Enrique Ferreyra
| |
| Oliver Wong 2006-03-28, 7:04 pm |
|
"eferreyra" <eferreyra@gmail.com> wrote in message
news:1143575783.041428.317390@i40g2000cwc.googlegroups.com...
> Hi we are starting to implement java and one thing i think will be more
> simple is the search in javadoc html files...
>
> Now im surfing on internet and the only tools i find have broken links
> or are commercial...
>
> We need to respond to questions like:
> "Where is the class for the Product Picker..?"
> "How is called the method for the interesrt calculation..."
> "etc. etc"
>
> I think if we have quality javadocs the problem was solved, but now i
> cant find some nice way to search in the javadocs...
>
> Can you tell me how you are resolving this ?
>
> There are good javadoc search tools ?
> Do you use some other intranet search tool ?
When you ask "How is called the method for the interesrt
calculation...", I'm not sure what you mean.
If you mean "What parameters does the method take?", then that
information will be in the JavaDocs. You can look up a particular method by
navigating into the index.
If you mean "What other methods call this method?", then that
information is NOT in the JavaDocs, and you'd probably need to use a
source-code browser like Eclipse to get this information. In Eclipse, you
can right click on a method and select "References -> Workspace", for
example, to find all the code that refers to that method.
- Oliver
| |
| Roedy Green 2006-03-28, 7:04 pm |
| On 28 Mar 2006 11:56:23 -0800, "eferreyra" <eferreyra@gmail.com>
wrote, quoted or indirectly quoted someone who said :
>There are good javadoc search tools ?
>Do you use some other intranet search tool ?
see google desktop. If you tell it to look only on your local machine
for filetype:html it will mostly find Javadoc.
See http://mindprod.com/jgloss/google.html
--
Canadian Mind Products, Roedy Green.
http://mindprod.com Java custom programming, consulting and coaching.
| |
|
|
| eferreyra 2006-03-29, 8:02 am |
| no, no, no....
We are 40 developers and currently (for give some idea) we have near to
20.000 source files in several languages, we do service for 5
enterprises (big and mid range) imagine that migrated to Java, we
expect code reusability minimize some things but still we cant say we
know where is everithing...
Now if i want to serach in the whole universe of html javadoc for
"Customer Credit Calculation" how i do that ?
| |
| eferreyra 2006-03-29, 8:02 am |
| We are 40 people here and the javadoc will be a universe of html, no
way we have the html in each local machine, so the google desktop not
applys here.
The javadocs are not published in the web so i think google web search
doesnt work.
I try a tool callend dnka or something like, for use google search in
mapped drives, but not the results i expect.
We like the idea of "Google Search" in our java docs, still i dont see
how, remember the javadocs are in a intranet.
| |
| eferreyra 2006-03-29, 8:02 am |
| Uh ?
We need to search words (like you do with google) but in the scope of
the javadocs, this javadocs are in the intranet, not accesible on
internet.
| |
| Thomas Weidenfeller 2006-03-29, 8:02 am |
| eferreyra wrote:
> We need to search words (like you do with google) but in the scope of
> the javadocs, this javadocs are in the intranet, not accesible on
> internet.
I really don't see your problem and why you seem to panic.
First, there are many search tools for desktop documents, corporate
intranet web servers, HTML etc. out there. Some of these search tools
are javadoc specific, others aren't. If you want such a search tool, get
one.
Second, javadoc itself generates some (not all) cross references. Click
on the "Use" button in the top bar of a class description. Probably this
is what you want, probably it isn't.
Third, there are other more or less javadoc compatible documentation
tools out there, which can generate extensive cross reference
documentation. At least one, doxygen, also comes with an own search
engine (requires a web server with PHP) and can chain independently
generated documentation together.
There is really no need to panic.
/Thomas
--
The comp.lang.java.gui FAQ:
ftp://ftp.cs.uu.nl/pub/NEWS.ANSWERS...ng/java/gui/faq
http://www.uni-giessen.de/faq/archi...g.java.gui.faq/
| |
| Monique Y. Mudama 2006-03-29, 7:04 pm |
| On 2006-03-29, eferreyra penned:
> no, no, no....
>
> We are 40 developers and currently (for give some idea) we have near
> to 20.000 source files in several languages, we do service for 5
> enterprises (big and mid range) imagine that migrated to Java, we
> expect code reusability minimize some things but still we cant say
> we know where is everithing...
>
> Now if i want to serach in the whole universe of html javadoc for
> "Customer Credit Calculation" how i do that ?
Install a search engine on the web server where the javadocs live?
You're right that searching isn't a feature innate to javadocs. So,
you ask yourself the question, what would I use if I needed to search
any arbitrary set of documents that I were keeping on the intranet?
Then install that tool.
--
monique
Ask smart questions, get good answers:
http://www.catb.org/~esr/faqs/smart-questions.html
| |
| Roedy Green 2006-03-29, 7:04 pm |
| On 29 Mar 2006 04:48:14 -0800, "eferreyra" <eferreyra@gmail.com>
wrote, quoted or indirectly quoted someone who said :
>We like the idea of "Google Search" in our java docs, still i dont see
>how, remember the javadocs are in a intranet.
Google Desktop will map shared drives. It will even give simultaneous
access to several machines to everyone, though that seems a rather
dangerous feature.
--
Canadian Mind Products, Roedy Green.
http://mindprod.com Java custom programming, consulting and coaching.
| |
| Roedy Green 2006-03-29, 7:04 pm |
| On 29 Mar 2006 04:52:05 -0800, "eferreyra" <eferreyra@gmail.com>
wrote, quoted or indirectly quoted someone who said :
>We need to search words (like you do with google) but in the scope of
>the javadocs, this javadocs are in the intranet, not accesible on
>internet.
that is what Google Desktop is for. Google Desktop is for searching
local drives. Please see
http://mindprod.com/jgloss/google.html#DESKTOP
--
Canadian Mind Products, Roedy Green.
http://mindprod.com Java custom programming, consulting and coaching.
| |
| Roedy Green 2006-03-29, 7:04 pm |
| On Wed, 29 Mar 2006 09:01:49 -0700, "Monique Y. Mudama"
<spam@bounceswoosh.org> wrote, quoted or indirectly quoted someone who
said :
>You're right that searching isn't a feature innate to javadocs. So,
>you ask yourself the question, what would I use if I needed to search
>any arbitrary set of documents that I were keeping on the intranet?
>Then install that tool.
there are at least five of them. See
http://mindprod.com/jgloss/lucene.html
--
Canadian Mind Products, Roedy Green.
http://mindprod.com Java custom programming, consulting and coaching.
| |
| eferreyra 2006-03-29, 7:04 pm |
| ok, now everybody says me to use a search tool... again, back to the
very first question, what tools are you using and are working for you.
in addition to google desktop, i prefer some tool that runs on tomcat
or some appserver.
I want tools, with links, not a bunch of tools for searching, some
already been used for javadoc searching
Thanks!
| |
| eferreyra 2006-03-29, 7:04 pm |
| Roedy, i have a problem with google desktop:
Requiere Windows XP o Windows 2000 SP 3 o superior.
We work with Aix, Solaris, Sco, Linux, Windows, etc. but the server in
question were the javadocs resides currently is a Red Hat Enterprise 4,
could be other unix-type at any moment.
Thanks !
| |
| Monique Y. Mudama 2006-03-29, 7:04 pm |
| On 2006-03-29, eferreyra penned:
>
> I want tools, with links, not a bunch of tools for searching, some
> already been used for javadoc searching
>
I want a beautiful chalet in the Swiss Alps, a trust fund that
deposits $25,000 into my bank account every month, and a puppy.
WHY WON'T ANYONE GIVE ME THESE THINGS?????!?@!@#!?
--
monique
Ask smart questions, get good answers:
http://www.catb.org/~esr/faqs/smart-questions.html
| |
| eferreyra 2006-03-29, 7:04 pm |
| You do the first step, you ask for it.
| |
| Monique Y. Mudama 2006-03-29, 7:04 pm |
| On 2006-03-29, eferreyra penned:
> You do the first step, you ask for it.
That explains a lot. I would have said, "You go get it."
Look, you asked for some information. Many people tried to be helpful
by pointing you in the right direction. You basically came back with,
"But I don't want you to just show me how to figure it out myself; I
want you to do all the work for me!"
If it had happened that someone knew of a project or product that
exactly fit your needs, great! But I think it's really ungrateful of
you to ask everyone to do more work than you are willing to do
yourself.
--
monique
Ask smart questions, get good answers:
http://www.catb.org/~esr/faqs/smart-questions.html
| |
| Roedy Green 2006-03-29, 7:04 pm |
| On 29 Mar 2006 10:52:12 -0800, "eferreyra" <eferreyra@gmail.com>
wrote, quoted or indirectly quoted someone who said :
>Roedy, i have a problem with google desktop:
>
>Requiere Windows XP o Windows 2000 SP 3 o superior.
I gave you four alternatives.
Looking up their names in Google will probably help you find similar
ones till you find one that suits your needs.
Consider, you are not the first person to have this problem.
Worse comes to worse, you put this stuff into an SQL database.
See http://mindprod.com/projects/javadoctools.html
--
Canadian Mind Products, Roedy Green.
http://mindprod.com Java custom programming, consulting and coaching.
| |
| Boris Gorjan 2006-03-30, 4:02 am |
| eferreyra wrote:
> Roedy, i have a problem with google desktop:
>
> Requiere Windows XP o Windows 2000 SP 3 o superior.
>
> We work with Aix, Solaris, Sco, Linux, Windows, etc. but the server in
> question were the javadocs resides currently is a Red Hat Enterprise 4,
> could be other unix-type at any moment.
As long as you have an operational JVM running on those machines:
[url]http://www.inters .com/[/url]
| |
| eferreyra 2006-03-30, 8:02 am |
| Sorry the thing go that way, i have to implement a VCS tool, i have to
integrate this with the IDE, y have to make the framework for ORM i
have at least 4 frameworks to implement and more to come, security,
validation, data entry forms, profile, logging, pickers, etc. I have to
find a UML documentation tool, i have to implement a AppServer and a
deplyment framework for rich client apps, i need to implement a project
tracking and planning tool, i can continue.... (but i have time limits)
Some things i do lot of homework and i come to conclusions, for example
iBatis is our ORM tool, subversion for VCS, etc. Other simply i found
it fast, the java logging and log4j, JGoodies validation.
>From the beggining i think (maybe wrong?) javadoc solves lots of
documentation problems, but mostly this topic issue, to find certaint
things in the wole world of java clases, kind of i expect this issue be
cook and not do other big search thru internet for conten management
tools, desktop search tools, web search engines, etc. i was looking for
the (two, three maybe) tools for javadoc searching.
Thanks all for your time and take my apologies, i dont think this would
be some complicated issue...
| |
| Monique Y. Mudama 2006-03-30, 7:05 pm |
| On 2006-03-30, eferreyra penned:
>
> documentation problems
Javadoc does solve a lot of documentation problems. It allows you to
write useful comments in the code from which you can generate linked
documentation. Before Javadoc, I'm not aware of a tool that did this
(although several now exist).
Unfortunately, javadocs don't include a search engine. This may be in
part because including a search engine would tie the documents to a
particular web server or server structure. Right now, you don't even
need a web server to make use of javadocs.
--
monique
Ask smart questions, get good answers:
http://www.catb.org/~esr/faqs/smart-questions.html
|
|
|
|
|