Apache OpenOffice (AOO) Bugzilla – Full Text Issue Listing
|Summary:||OOo Javadoc incomplete|
|Product:||App Dev||Reporter:||tobiaskrais <tux-spam>|
|Component:||api||Assignee:||AOO issues mailing list <issues>|
|Status:||CONFIRMED ---||QA Contact:|
|Priority:||P3||CC:||cmarcum, damjan, issues, maison.godard, mseidel, mux2005, oliver.brinzing, shenmux09|
|Issue Type:||DEFECT||Latest Confirmation in:||---|
Description tobiaskrais 2008-01-31 08:57:50 UTC
For some files I found a javadoc in the folder /usr/lib/openoffice/sdk/docs/java/ref/. But the rest is missing. I tried to add /usr/lib/openoffice/sdk/docs/common/ref/. But this is an incomplete Javadoc, missing some files needed for complete Javadoc. Please provide a complete Javadoc to be able to add it to Eclipse or other IDEs.
Comment 1 jsc 2008-01-31 10:23:55 UTC
You should describe the problem in more detail. I can include the IDL reference documents in NetBeans and it works. If Eclipse needs something special please provide an example and i am sure that we can provide it. But i don't have time to investigate in this problem at the moment. As long as i got no further input i set the target to 3.x. Waiting on further input ...
Comment 2 tobiaskrais 2008-01-31 10:39:38 UTC
tobiaskrais -> jsc: unfortuneatly I am not a Javadoc specialist. But Eclipse needs a complete javadoc with an index.html as a starting point. OOo comes along with an example: /usr/lib/openoffice/sdk/docs/java/ref/index.html. Opening this file in a browser shows you what the documentation in /usr/lib/openoffice/sdk/docs/common/ref should look like. First of all Eclipse complains that the index.html is missing. Most IDEs come along with tools creating the Javadoc automatically. You might ask the ones creating the /usr/lib/openoffice/sdk/docs/java/ref/ Javadoc, how they created it and how you can adopt the technique. I hope this helps. I not, please tell me.
Comment 3 jsc 2008-01-31 11:25:53 UTC
well the openoffice/sdk/docs/java/ref is generated by me or at least i have defined the rules in the build process. But that is completly different from the IDL reference. We adopt autodoc (the tool that generates the reference docu) to generate javadoc like index files. This files can be integrated in NetBeans for example and i believe it is more or less the same in Eclipse. I have tried it in past, i can't remember when exactly.
Comment 4 Oliver Brinzing 2008-01-31 17:21:38 UTC
added me to cc
Comment 5 jsc 2009-01-22 08:23:38 UTC
jsc -> np: our generated IDL reference seems to be still not compatible with Javadoc. Can you please take a look on it
Comment 6 Carl Marcum 2016-04-06 23:49:52 UTC
Javadocs for the Java UNO api's that have java sources are available for download from Maven repositories as of v.4.1.2. However javadocs as built for the SDK are still incomplete and that still needs fixed.
Comment 7 damjan 2017-02-15 15:56:55 UTC
I've looked at javadoc building as part of the gbuild migration, and can probably help. Please give an example class/method that is missing, and where it's missing from.
Comment 8 Carl Marcum 2017-02-28 00:48:31 UTC
Created attachment 85969 [details] uno javadocs for juh, jurt, and ridl I made this manually from combined sources from juh, jurt, and ridl. If you compare it to the javadoc included with the sdk in sdk/docs/java/ref you will see the classes missing.
Comment 9 Carl Marcum 2017-02-28 00:59:58 UTC
Also unoil classes seem to be generated from IDL so no java sources are created to generate javadoc from.