Bugzilla – Full Text Bug Listing
| Summary: | javadoc causes exception | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Eclipse Project] JDT | Reporter: | arne anka <eclipse-bugs> | ||||
| Component: | Core | Assignee: | JDT-Core-Inbox <jdt-core-inbox> | ||||
| Status: | CLOSED WONTFIX | QA Contact: | |||||
| Severity: | normal | ||||||
| Priority: | P3 | CC: | martinae, Olivier_Thomann, philippe_mulet | ||||
| Version: | 3.3.2 | ||||||
| Target Milestone: | --- | ||||||
| Hardware: | PC | ||||||
| OS: | Linux | ||||||
| Whiteboard: | stalebug | ||||||
| Attachments: |
|
||||||
Could you please provide: - the build id - where to get the javadoc for this package ? Thanks. Created attachment 95538 [details]
converted deb-package containing the javadoc mentioned in bug
Build id: M20080221-1800 javadoc: as mentioned, it is include in the deb-package. Version: 1.0-4 at pool/main/libj/libjdom1-java/libjdom1-java_1.0-4_all.deb on any mirror next to you, f ex ftp://ftp.fu-berlin.de/unix/linux/debian-mirror/debian/pool/main/libj/libjdom1-java/libjdom1-java_1.0-4_all.deb i created an attachement containig both the javadoc and the jar, converted from deb to tar.gz for convenience. I would not be surprised that this doc has not been generated using the javadoc tool. This would explain that the format is unknown. I'll investigate. I can confirm that the javadoc format in this case is clearly not standard. When the doc for the type is extracted, the first thing we try to find is: <!-- ======== START OF CLASS DATA ======== --> And this is not there. I don't think we should try to fix any kind of documentation format that might show up. We should support the "standard" documentation generated using the javadoc tool. In this specific case, we should look for the <div> tag that is <div class="class description"> and extract the "contents" what is inside the <div class="class description">...</div> tags. Philippe, do we want to support different javadoc format ? Right now we support the javadoc format generated by the Javadoc tool. well, it is the format most or all debian java packages come with. i don't know what they use to geerate it, but i filed a bug report which may hopefully shed some light. Is there a spec for this non-standard format ? Olivier - how much work is that to support it ? Feels like nice to have, but not compulsory, at least for 3.4. I don't think it is difficult to support once we know the format. I think we should extract the javadoc format out of the javadoc extraction to make it more flexible. We might need an extension point and a change in the javadoc attachment to say what extension point should be used to extract the doc. Definitely not for 3.4. debian bug number is #476286 (http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=476286). the tool used to generate the doc is gjdoc which (given the name) should belong to the gcj suite and thus might gain some reputation as kind of standard tool in the future. the claim to be compatible to javadoc up to and including version 1.4. so, do they have compatibility issue or does eclipse have? The string "<!-- ======== START OF CLASS DATA ======== -->" is not generated in the javadoc produced by gjdoc. I'll see if we can fix this. This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. -- The automated Eclipse Genie. |
i use jdom1.jar from debian/unstable's libjdom1-java package and added the included javadoc. but every time i hover over an element from the jar i get something like: !ENTRY org.eclipse.jdt.core 4 1009 2008-04-10 16:03:20.496 !MESSAGE Unknown javadoc format for JDOMException {key=Lorg/jdom/JDOMException;} [in JDOMException.class [in org.jdom [in /usr/share/java/jdom1.jar]]]