 |
 | Home | Contact Us | FAQ | Search & Site Map | Link to Us |
 | Sign In | Join | Other 45 Sites in Network |
Java Forum / First Aid / March 2006Javadoc search tool ... is this new ???
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 > Hi we are starting to implement java and one thing i think will be more > simple is the search in javadoc html files... [quoted text clipped - 14 lines] > 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 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 ? > no, no, no.... > [quoted text clipped - 6 lines] > 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.  Signaturemonique Ask smart questions, get good answers: http://www.catb.org/~esr/faqs/smart-questions.html 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 SignatureCanadian Mind Products, Roedy Green. http://mindprod.com Java custom programming, consulting and coaching. >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 SignatureCanadian Mind Products, Roedy Green. http://mindprod.com Java custom programming, consulting and coaching. 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. >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. SignatureCanadian Mind Products, Roedy Green. http://mindprod.com Java custom programming, consulting and coaching. i think you are not need javadoc .you are need java api. this website can tell you http://java.sun.com/j2se/1.5.0/docs/index.html 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. > 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 SignatureThe comp.lang.java.gui FAQ: ftp://ftp.cs.uu.nl/pub/NEWS.ANSWERS/computer-lang/java/gui/faq http://www.uni-giessen.de/faq/archiv/computer-lang.java.gui.faq/ 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! > 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?????!?@!@#!? Signaturemonique Ask smart questions, get good answers: http://www.catb.org/~esr/faqs/smart-questions.html You do the first step, you ask for it. > 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. Signaturemonique Ask smart questions, get good answers: http://www.catb.org/~esr/faqs/smart-questions.html 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... >>From the beggining i think (maybe wrong?) javadoc solves lots of > 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. Signaturemonique Ask smart questions, get good answers: http://www.catb.org/~esr/faqs/smart-questions.html >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 SignatureCanadian Mind Products, Roedy Green. http://mindprod.com Java custom programming, consulting and coaching. 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 ! >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 SignatureCanadian Mind Products, Roedy Green. http://mindprod.com Java custom programming, consulting and coaching. > Roedy, i have a problem with google desktop: > [quoted text clipped - 3 lines] > 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: http://www.interseek.com/ Free MagazinesGet these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...
|
Reply to this Message
|
 Sign In
 Join
 My Latest Posts My Monitored Threads My Blog My Photo Gallery My Profile My Homepage Start New Thread Enable EMail Alerts Rate this Thread
|
©2008 Advenet LLC Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.