"Hummm... actually, I don't think that they use the javadoc itself... What they probably do is parse the code to gather the comments and use that info to know what to present (so, not much that can be rearranged)."
You and I are talking about two related but separate use cases, I think. Yours: user writes code with docustrings in PyDev project; docustrings are parsed when code is 'compiled' and stored in resource somewhere (XML file?) for later lookup. Mine (Java case): user includes rt.jar file, makes association with javadoc directory in project settings (see attached picture). "So, what I thought was to make the javadoc available in the help... The hovering is probably going to work on the same base that the code-completion works, getting the docs from the code itself..." For the python case, I guess this would work (but not in the Java case as the jar files don't have comments). I wonder, though, if we can leverage the javadoc file association as in the case above? Not quite the same, is it, since there's nothing to associate the javadoc with? Guess I see the point now. It's possible that even in the case where the rt.jar <-> javadoc association is made, the javadocs are parsed into a lookup structure rather than relying browser HTML navigation. Too much of a newbie to know, myself. So there is a tool out there to generate API docs from Python docustrings call Epydoc. Whatever route is taken, I think that is the tool to use. How fast is it? -- that's the question. For project file docustrings it's no doubt fast enough, but for the entire Python library?? I think there are two choices: 1) distributing with a pre-generated api docs; 2) have logic to do a one-time api doc generation. Distributing with pre-generated stuff would work until a new Python version came along; generating once, base on version determined by PYTHONHOME setting would be better, I think, and then reuse the generated documentation until a new one is needed. I think you'll agree that last makes sense. Do we even need the Javadoc at all then? I'm not sure what help you are referring to: F1 help? "There is a faq on how to add a hover to the text: http://wiki.eclipse.org/index.php/FAQ_How_do_I_add_hover_support_to_my_text_editor%3F"; It's a good start. From that I might be able to figure out how the linkage is made between .jar files and their javadocs. "There is already a hover implemented for errors, but it has to be extended for adding the pydocs. The class that does it is: PyTextHover (basically, the getHoverInfo method would have to make something as a code-completion request and with the info returned, present the hover -- in addition to what is already shown). " Yeah, found PyTextHover today. The light is slowly dawning. "To make the code completion, you'd have to check the PythonCompletionProcessor, that currently makes the code-completion (it might need some customizing for that, but not so much). "So, if you're up to the task and want more info... Should not be so hard to implement... (I can give you some tips on how to do it)." Got an ant build file or .project/.classpath pair? Can't figure out which modules I need from CVS... looks like some old stuff in there. "You should register in the pydev-code list... That's the place where this kind of discussion belongs" Okay, the request is in. Take care, Jeff -- _______________________________________________ Surf the Web in a faster, safer and easier way: Download Opera 8 at http://www.opera.com Powered by Outblaze ------------------------------------------------------- This SF.Net email is sponsored by xPML, a groundbreaking scripting language that extends applications into web and mobile media. Attend the live webcast and join the prime developer group breaking into this new coding territory! http://sel.as-us.falkag.net/sel?cmd=lnk&kid0944&bid$1720&dat1642 _______________________________________________ Pydev-code mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/pydev-code
