nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

A holistic Javadoc for BIRT?

evgeny

Hi, 
 
I was wondering if there is a complete Javadoc for Birt at one webiste, because as far as I saw there are several Javadocs which describe several packages each, but no javadoc where there are all classes. 
 
I am looking for a single Javadoc with all the packages like these: 
<a class='bbc_url' href='http://www.birt-exchange.org/documentation/BIRT_231/EngineJavadoc/model/api/index.html'>BIRT Model API 2.3.0</a> 
<a class='bbc_url' href='http://www.birt-exchange.org/documentation/BIRT_231/EngineJavadoc/enginescript/api/index.html'>Birt Script API 2.3.0</a> 
<a class='bbc_url' href='http://www.birt-exchange.org/documentation/BIRT_231/ChartJavadoc/chart/api/index.html'>BIRT Chart Engine API</a> 
<a class='bbc_url' href='http://www.birt-exchange.org/documentation/BIRT_231/ChartJavadoc/chartscript/api/index.html'>BIRT Chart Simple API</a> 
<a class='bbc_url' href='http://www.birt-exchange.org/documentation/BIRT_231/ChartJavadoc/chartui/api/index.html'>BIRT Chart UI Extension Interfaces</a> 
<a class='bbc_url' href='http://www.birt-exchange.org/documentation/BIRT_231/EngineJavadoc/data/api/index.html'>BIRT Data Engine API 2.3.0 Specification - Provisional</a> 
<a class='bbc_url' href='http://www.birt-exchange.org/documentation/BIRT_231/EngineJavadoc/engine/api/index.html'>Birt Engine API 2.3.0</a> 
 
Thanks 
 
Evgeny

Find more posts tagged with

Comments

JasonW

The JavaDocs should be in the help guide.

Jason

evgeny

Yeah thanks, It wasn't included in the all-in-one download package. So i just downloaded it with the software updater of eclipse.

Actually now I would like to know if it is possible to bind this javadocs to the classes. So that I can see the javadoc in Eclipse with the mouse tool-tip option.

Thanks

hq4ever

I would go 1 step further and perhaps request the compilation to not strip the source code from the compiled classes. This will allow us to view the API using eclipse tools tips instead of searching the API seperatly.

For an example you can try to view the API of Integer and then (ctrl+ mouse click) go into the compiled class to see the source it was compiled from.

JasonW

Can you open an enhancement request in bugzilla for this?

hq4ever

<blockquote class='ipsBlockquote' data-author="JasonW">Can you open an enhancement request in bugzilla for this?</blockquote>
 
Done. <a class='bbc_url' href='https://bugs.eclipse.org/bugs/show_bug.cgi?id=287846'>https://bugs.eclipse.org/bugs/show_bug.cgi?id=287846</a>

evgeny

<blockquote class='ipsBlockquote' data-author="hq4ever">I would go 1 step further and perhaps request the compilation to not strip the source code from the compiled classes. This will allow us to view the API using eclipse tools tips instead of searching the API seperatly. </blockquote>
 
<blockquote class='ipsBlockquote' data-author="hq4ever">Done. <a class='bbc_url' href='https://bugs.eclipse.org/bugs/show_bug.cgi?id=287846'>https://bugs.eclipse.org/bugs/show_bug.cgi?id=287846</a></blockquote>
 
Can please explain this in more detail. 
When I am doing Ctr+mouse click, I get a "no source attached" window which refers to the compiled jar. How can I attach the javadocs and the sourcecode? 
 
I also noticed that the Birt developer reference doesn't include all the Javadocs for all classes, for example I couldn't find the reportContext class. 
 
Thanks 
 
Evgeny

Farrah

<blockquote class='ipsBlockquote' data-author="hq4ever">Done. <a class='bbc_url' href='https://bugs.eclipse.org/bugs/show_bug.cgi?id=287846'>https://bugs.eclipse.org/bugs/show_bug.cgi?id=287846</a></blockquote>
 
 
BIRT already turned on debug in javac target. 
 
You need to install Eclipse SDK to see the javadoc in javadoc view by mouse selection. AllInOne is not using the SDK package.

OneWorld

Hi, 
 
I just downloaded the <a class='bbc_url' href='http://www.eclipse.org/downloads/download.php?file=/birt/downloads/drops/R-R1-2_6_2-201102191842/birt-runtime-2_6_2.zip'>Report Engine</a> Unfortunatly, no documentation was integrated in the download. So, I can't see the documentation in Eclipse when hovering over classes and methods. 
 
Could somebody please be so kind and explain where to download the missing files and how to set up my eclipse with it? 
 
 
So far I just added all files from <pre class='_prettyXprint _lang-auto _linenums:0'>birtruntime\2-6-2\ReportEngine\lib</pre> as external JARs to my build path. 
 
Thank you!