Javadocs in Eclipse

How to do javadocs in Eclipse?

Javadoc is a tool for generating API documentation in HTML format from doc comments in source code.
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

Similar Messages

Generate a javadoc with eclipse

hello!!!
Is someone know how to generate a javadoc with eclipse???
I find one solution, but I have to set the javadoc.exe location, and i don't know where is it...
please could you help me???
s@bine

javadoc.exe file is in the same place as your java.exe file
%JAVA_HOME%\bin
You need to get the full JDK (not just the JRE) and I know this is the case for JDK 1.2 and above (not sure about any other previous version)

Using javadocs in Eclipse

My team and I are trying to use javadocs in eclipse to document our source codes. I have used the javadoc generator in eclipse but do I have to manual comment in the details of the javadoc such as parameters, and a summary of the method? Is it possible to hide the javadocs? We just want to have a seperate folder for javadocs where we can view/edit the javadocs and still have no javadocs or comments within our code. anyone got suggestions????

Hi,
Well, Eclipse adds nothing special here. But you have actually an interesting idea...
Some (long) time ago I used to hear that it was hailed as a big progress a possibility to store all actual descriptions along with the Java code and to generate by them the entire finished documentation automatically. But now, it seems, you want to go back in time...
I believe, the standard Javadoc is unable to support anything like this.
However, if you still want to use Javadoc in such an arrangement so as to generate the overall documentation skeleton (as well as to employ Javadoc's HTML output engine), you will need to develop your own doclet or a taglet, at least.
For instance, you could introduce some special tags using which you would specify the locations of your description files (directly or using some identifiers). Then, your taglet would process those tags, read those descriptions from the files and feed them to Javadoc.
Another way is to imply the locations of your description files from the program element (i.e. class, method or field) being processed by Javadoc. The doclet API provides all necessary information together with the location of a Java source file. So you could use it to find your custom description files somewhere nearby it.
I suggest also to look at this product:
http://www.filigris.com/products/docflex_javadoc/
This is a highly customizable Javadoc doclet. More precisely, this is a system for rapid development of professional quality doclets from scratch (with the support of both framed/single-file HTML and RTF output). If you are prepared to buy some number of licenses, we could very much customize this product for your needs. So, your task will be solved with no problem.
Regards,
Leonid Rudy
http://www.docflex.com

Javadoc in eclipse offline?

I have noticed that JavaDoc info only works in eclipse when I am connected to the internet. Is there someway to make it work in eclipse when I am offline??

Are you getting an error message? What does it say?

Viewing javadoc's in eclipse

Hello, just a quick one...
When using eclipse, if i click on a class name which is in the standard API then i can view the javadoc through eclipse, how can i set this up so i can view it for non standerd classes, which come with the source code and or javadocs in a seperate file?
Thanks for any help

Select your project, then navigate to Project > Properties; select 'Java Build Path' and select the tab 'Libraries'; select the .jar file you want to attach javadocs for (expand it) and select the option 'Javadoc location'; select the directory where the (API) docs are stored and voila.
kind regards,
Jos

Eclipse plugin for Javadoc available?

I'm using javadoc.exe from cmd line windows and saw a few plugins for eclipse. which ones are recommended?
also, any good generic ant script code for this available?
BTW: using JDK 5 and Eclipse 3.4 with JBDS 2.0
Edited by: asookazian on Mar 17, 2009 10:04 AM
Edited by: asookazian on Mar 17, 2009 10:04 AM

asookazian wrote:
I'm using javadoc.exe from cmd line windows and saw a few plugins for eclipse. which ones are recommended?Eclipse comes with built-in javadoc (File->Export->Javadoc), no need to use a non-standard plugin.
asookazian wrote:
also, any good generic ant script code for this available?ANT comes with a javadoc task and its documentation includes several usage examples. It doesn't get anymore generic than this.

Error during generation of the WSDL: BUILD FAILED java.lang.NoClassDefFoundError: com/sun/javadoc/Type

When I create an EJB Transport Business Service, after selecting the jar that has the EJB 2.1 artefacts (Remote, Home, etc) the oepe plugin fails and can't continue.
As I understand it seems that there is a problem with the classpath of ant build.xml that oepe creates inside folder /tmp/alsbejbtransport/ to compile the bs and generate the wsdl. I checked if tools.jar is in the classpath (in eclipse) and is included, so I can't figure out wich is the problem.
I found this in Oracle, but not helps solve the problem:
BEA-398120
Error: The WSDL for the typed transport endpoint could not be accessed.
Description
There was a problem retrieving the WSDL from the typed transport service endpoint at the time of service registration
Action
Contact technical support
This is the the full stacktrace that shows eclipse.
Generate : Error during generation of the WSDL:
BUILD FAILED
java.lang.NoClassDefFoundError: com/sun/javadoc/Type
        at com.bea.util.jam.provider.JamServiceFactoryImpl.createSourceBuilder(JamServiceFactoryImpl.java:205)
        at com.bea.util.jam.provider.JamServiceFactoryImpl.createBuilder(JamServiceFactoryImpl.java:158)
        at com.bea.util.jam.provider.JamServiceFactoryImpl.createClassLoader(JamServiceFactoryImpl.java:137)
        at com.bea.util.jam.provider.JamServiceFactoryImpl.createService(JamServiceFactoryImpl.java:78)
        at weblogic.wsee.util.JamUtil.parseSource(JamUtil.java:152)
        at weblogic.wsee.tools.anttasks.JwsLoader.loadJClasses(JwsLoader.java:186)
        at weblogic.wsee.tools.anttasks.JwsLoader.load(JwsLoader.java:75)
        at weblogic.wsee.tools.anttasks.JwsModule.loadWebServices(JwsModule.java:569)
        at weblogic.wsee.tools.anttasks.JwsModule.generate(JwsModule.java:369)
        at weblogic.wsee.tools.anttasks.JwsModule.build(JwsModule.java:256)
        at weblogic.wsee.tools.anttasks.JwscTask.execute(JwscTask.java:184)
        at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:288)
        at sun.reflect.GeneratedMethodAccessor1.invoke(Unknown Source)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.lang.reflect.Method.invoke(Method.java:601)
        at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:106)
        at org.apache.tools.ant.Task.perform(Task.java:348)
        at org.apache.tools.ant.Target.execute(Target.java:357)
        at org.apache.tools.ant.Target.performTasks(Target.java:385)
        at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1337)
        at org.apache.tools.ant.Project.executeTarget(Project.java:1306)
        at org.apache.tools.ant.helper.DefaultExecutor.executeTargets(DefaultExecutor.java:41)
        at org.apache.tools.ant.Project.executeTargets(Project.java:1189)
        at org.apache.tools.ant.Main.runBuild(Main.java:758)
        at org.apache.tools.ant.Main.startAnt(Main.java:217)
        at org.apache.tools.ant.launch.Launcher.run(Launcher.java:257)
        at org.apache.tools.ant.launch.Launcher.main(Launcher.java:104)
Caused by: java.lang.ClassNotFoundException: com.sun.javadoc.Type
        at org.apache.tools.ant.AntClassLoader.findClassInComponents(AntClassLoader.java:1400)
        at org.apache.tools.ant.AntClassLoader.findClass(AntClassLoader.java:1341)
        at org.apache.tools.ant.AntClassLoader.loadClass(AntClassLoader.java:1088)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:356)
        ... 27 more
Total time: 0 seconds
Eclipse Installation details:
*** System properties:
eclipse.application=org.eclipse.ui.ide.workbench
eclipse.buildId=M20110909-1335
eclipse.commands=-os
linux
-ws
gtk
-arch
x86_64
-showsplash
-launcher
{home}/Development/oepe-indigo/eclipse
-name
Eclipse
--launcher.library
{home}/Development/oepe-indigo//plugins/org.eclipse.equinox.launcher.gtk.linux.x86_64_1.1.100.v20110505/eclipse_1407.so
-startup
{home}/Development/oepe-indigo//plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar
--launcher.overrideVmargs
-exitdata
1e418010
-vm
/usr/bin/java
eclipse.home.location=file:{home}/Development/oepe-indigo/
eclipse.launcher={home}/Development/oepe-indigo/eclipse
eclipse.launcher.name=Eclipse
[email protected]/../p2/
eclipse.p2.profile=PlatformProfile
eclipse.product=org.eclipse.platform.ide
eclipse.startTime=1374623921455
eclipse.vm=/usr/bin/java
eclipse.vmargs=-Xms256m
-Xmx768m
-XX:MaxPermSize=512m
-Dsun.lang.ClassLoader.allowArraySyntax=true
-Dweblogic.home={home}/Oracle/Middleware/wlserver_10.3
-Dharvester.home={home}/Oracle/Middleware/Oracle_OSB1/harvester
-Dosb.home={home}/Oracle/Middleware/Oracle_OSB1
-Dosgi.bundlefile.limit=750
-Dosgi.nl=en_US
-Dmiddleware.home={home}/Oracle/Middleware
-jar
{home}/Development/oepe-indigo//plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar
equinox.use.ds=true
file.encoding=UTF-8
file.encoding.pkg=sun.io
file.separator=/
guice.disable.misplaced.annotation.check=true
harvester.home={home}/Oracle/Middleware/Oracle_OSB1/harvester
http.nonProxyHosts=localhost
java.awt.graphicsenv=sun.awt.X11GraphicsEnvironment
java.awt.printerjob=sun.print.PSPrinterJob
java.class.path={home}/Development/oepe-indigo//plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar
java.class.version=50.0
java.endorsed.dirs=/usr/lib/jvm/jdk1.6.0_45/jre/lib/endorsed
java.ext.dirs=/usr/lib/jvm/jdk1.6.0_45/jre/lib/ext:/usr/java/packages/lib/ext
java.home=/usr/lib/jvm/jdk1.6.0_45/jre
java.io.tmpdir=/tmp
java.library.path=/usr/lib/jvm/jdk1.6.0_45/jre/lib/amd64/server:/usr/lib/jvm/jdk1.6.0_45/jre/lib/amd64:/usr/lib/jvm/jdk1.6.0_45/jre/../lib/amd64:/usr/java/packages/lib/amd64:/usr/lib64:/lib64:/lib:/usr/lib
java.protocol.handler.pkgs=null|com.bea.wli.sb.resources.url|com.bea.wli.sb.resources.jca.upgrade.url|weblogic.utils|weblogic.utils|weblogic.utils|weblogic.net|weblogic.net
java.runtime.name=Java(TM) SE Runtime Environment
java.runtime.version=1.6.0_45-b06
java.specification.name=Java Platform API Specification
java.specification.vendor=Sun Microsystems Inc.
java.specification.version=1.6
java.vendor=Sun Microsystems Inc.
java.vendor.url=http://java.sun.com/
java.vendor.url.bug=http://java.sun.com/cgi-bin/bugreport.cgi
java.version=1.6.0_45
java.vm.info=mixed mode
java.vm.name=Java HotSpot(TM) 64-Bit Server VM
java.vm.specification.name=Java Virtual Machine Specification
java.vm.specification.vendor=Sun Microsystems Inc.
java.vm.specification.version=1.0
java.vm.vendor=Sun Microsystems Inc.
java.vm.version=20.45-b01
javax.rmi.CORBA.PortableRemoteObjectClass=weblogic.iiop.PortableRemoteObjectDelegateImpl
javax.rmi.CORBA.UtilClass=weblogic.iiop.UtilDelegateImpl
jna.platform.library.path=/usr/lib/x86_64-linux-gnu:/lib/x86_64-linux-gnu:/lib64:/usr/lib:/lib
line.separator=
middleware.home={home}/Oracle/Middleware
oracle.eclipse.tools.weblogic.ui.isWebLogicServer=true
org.apache.commons.logging.Log=org.apache.commons.logging.impl.NoOpLog
org.eclipse.equinox.launcher.splash.location={home}/Development/oepe-indigo/plugins/org.eclipse.platform_3.7.1.v201109091335/splash.bmp
org.eclipse.equinox.simpleconfigurator.configUrl=file:org.eclipse.equinox.simpleconfigurator/bundles.info
org.eclipse.m2e.log.dir={home}/workspace/pragma/.metadata/.plugins/org.eclipse.m2e.logback.configuration
org.eclipse.update.reconcile=false
org.omg.CORBA.ORBClass=weblogic.corba.orb.ORB
org.omg.CORBA.ORBSingletonClass=weblogic.corba.orb.ORB
org.osgi.framework.executionenvironment=OSGi/Minimum-1.0,OSGi/Minimum-1.1,OSGi/Minimum-1.2,JRE-1.1,J2SE-1.2,J2SE-1.3,J2SE-1.4,J2SE-1.5,JavaSE-1.6
org.osgi.framework.language=en
org.osgi.framework.os.name=Linux
org.osgi.framework.os.version=3.8.0
org.osgi.framework.processor=x86-64
org.osgi.framework.system.capabilities=osgi.ee; osgi.ee="OSGi/Minimum"; version:List<Version>="1.0, 1.1, 1.2",osgi.ee; osgi.ee="JavaSE"; version:List<Version>="1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6"
org.osgi.framework.system.packages=javax.accessibility,javax.activation,javax.activity,javax.annotation,javax.annotation.processing,javax.crypto,javax.crypto.interfaces,javax.crypto.spec,javax.imageio,javax.imageio.event,javax.imageio.metadata,javax.imageio.plugins.bmp,javax.imageio.plugins.jpeg,javax.imageio.spi,javax.imageio.stream,javax.jws,javax.jws.soap,javax.lang.model,javax.lang.model.element,javax.lang.model.type,javax.lang.model.util,javax.management,javax.management.loading,javax.management.modelmbean,javax.management.monitor,javax.management.openmbean,javax.management.relation,javax.management.remote,javax.management.remote.rmi,javax.management.timer,javax.naming,javax.naming.directory,javax.naming.event,javax.naming.ldap,javax.naming.spi,javax.net,javax.net.ssl,javax.print,javax.print.attribute,javax.print.attribute.standard,javax.print.event,javax.rmi,javax.rmi.CORBA,javax.rmi.ssl,javax.script,javax.security.auth,javax.security.auth.callback,javax.security.auth.kerberos,javax.security.auth.login,javax.security.auth.spi,javax.security.auth.x500,javax.security.cert,javax.security.sasl,javax.sound.midi,javax.sound.midi.spi,javax.sound.sampled,javax.sound.sampled.spi,javax.sql,javax.sql.rowset,javax.sql.rowset.serial,javax.sql.rowset.spi,javax.swing,javax.swing.border,javax.swing.colorchooser,javax.swing.event,javax.swing.filechooser,javax.swing.plaf,javax.swing.plaf.basic,javax.swing.plaf.metal,javax.swing.plaf.multi,javax.swing.plaf.synth,javax.swing.table,javax.swing.text,javax.swing.text.html,javax.swing.text.html.parser,javax.swing.text.rtf,javax.swing.tree,javax.swing.undo,javax.tools,javax.transaction,javax.transaction.xa,javax.xml,javax.xml.bind,javax.xml.bind.annotation,javax.xml.bind.annotation.adapters,javax.xml.bind.attachment,javax.xml.bind.helpers,javax.xml.bind.util,javax.xml.crypto,javax.xml.crypto.dom,javax.xml.crypto.dsig,javax.xml.crypto.dsig.dom,javax.xml.crypto.dsig.keyinfo,javax.xml.crypto.dsig.spec,javax.xml.datatype,javax.xml.namespace,javax.xml.parsers,javax.xml.soap,javax.xml.stream,javax.xml.stream.events,javax.xml.stream.util,javax.xml.transform,javax.xml.transform.dom,javax.xml.transform.sax,javax.xml.transform.stax,javax.xml.transform.stream,javax.xml.validation,javax.xml.ws,javax.xml.ws.handler,javax.xml.ws.handler.soap,javax.xml.ws.http,javax.xml.ws.soap,javax.xml.ws.spi,javax.xml.ws.wsaddressing,javax.xml.xpath,org.ietf.jgss,org.omg.CORBA,org.omg.CORBA_2_3,org.omg.CORBA_2_3.portable,org.omg.CORBA.DynAnyPackage,org.omg.CORBA.ORBPackage,org.omg.CORBA.portable,org.omg.CORBA.TypeCodePackage,org.omg.CosNaming,org.omg.CosNaming.NamingContextExtPackage,org.omg.CosNaming.NamingContextPackage,org.omg.Dynamic,org.omg.DynamicAny,org.omg.DynamicAny.DynAnyFactoryPackage,org.omg.DynamicAny.DynAnyPackage,org.omg.IOP,org.omg.IOP.CodecFactoryPackage,org.omg.IOP.CodecPackage,org.omg.Messaging,org.omg.PortableInterceptor,org.omg.PortableInterceptor.ORBInitInfoPackage,org.omg.PortableServer,org.omg.PortableServer.CurrentPackage,org.omg.PortableServer.POAManagerPackage,org.omg.PortableServer.POAPackage,org.omg.PortableServer.portable,org.omg.PortableServer.ServantLocatorPackage,org.omg.SendingContext,org.omg.stub.java.rmi,org.w3c.dom,org.w3c.dom.bootstrap,org.w3c.dom.css,org.w3c.dom.events,org.w3c.dom.html,org.w3c.dom.ls,org.w3c.dom.ranges,org.w3c.dom.stylesheets,org.w3c.dom.traversal,org.w3c.dom.views,org.w3c.dom.xpath,org.xml.sax,org.xml.sax.ext,org.xml.sax.helpers
org.osgi.framework.uuid=901615cd-f3f3-0012-11b6-a3bca4d97ac1
org.osgi.framework.vendor=Eclipse
org.osgi.framework.version=1.6.0
org.osgi.supports.framework.extension=true
org.osgi.supports.framework.fragment=true
org.osgi.supports.framework.requirebundle=true
os.arch=amd64
os.name=Linux
os.version=3.8.0-26-generic
osb.home={home}/Oracle/Middleware/Oracle_OSB1
osgi.arch=x86_64
osgi.bundlefile.limit=750
osgi.bundles=reference:file:javax.transaction_1.1.1.v201105210645.jar,reference:file:org.eclipse.equinox.simpleconfigurator_1.0.200.v20110502-1955.jar@1:start
osgi.bundles.defaultStartLevel=4
osgi.bundlestore={home}/Development/oepe-indigo/configuration/org.eclipse.osgi/bundles
osgi.configuration.area=file:{home}/Development/oepe-indigo/configuration/
osgi.framework=file:{home}/Development/oepe-indigo/plugins/org.eclipse.osgi_3.7.1.R37x_v20110808-1106.jar
osgi.framework.extensions=reference:file:javax.transaction_1.1.1.v201105210645.jar
osgi.framework.shape=jar
osgi.framework.version=3.7.1.R37x_v20110808-1106
osgi.frameworkClassPath=., file:{home}/Development/oepe-indigo/plugins/javax.transaction_1.1.1.v201105210645.jar
osgi.install.area=file:{home}/Development/oepe-indigo/
osgi.instance.area=file:{home}/workspace/pragma/
osgi.instance.area.default=file:{home}/workspace/
osgi.logfile={home}/workspace/pragma/.metadata/.log
osgi.manifest.cache={home}/Development/oepe-indigo/configuration/org.eclipse.osgi/manifests
osgi.nl=en_US
osgi.nl.user=en_US
osgi.os=linux
osgi.splashLocation={home}/Development/oepe-indigo/plugins/org.eclipse.platform_3.7.1.v201109091335/splash.bmp
osgi.splashPath=platform:/base/plugins/org.eclipse.platform
osgi.syspath={home}/Development/oepe-indigo/plugins
osgi.tracefile={home}/workspace/pragma/.metadata/trace.log
osgi.ws=gtk
path.separator=:
securerandom.source=file:/dev/./urandom
socksNonProxyHost=localhost
sun.arch.data.model=64
sun.boot.class.path=/usr/lib/jvm/jdk1.6.0_45/jre/lib/resources.jar:/usr/lib/jvm/jdk1.6.0_45/jre/lib/rt.jar:/usr/lib/jvm/jdk1.6.0_45/jre/lib/sunrsasign.jar:/usr/lib/jvm/jdk1.6.0_45/jre/lib/jsse.jar:/usr/lib/jvm/jdk1.6.0_45/jre/lib/jce.jar:/usr/lib/jvm/jdk1.6.0_45/jre/lib/charsets.jar:/usr/lib/jvm/jdk1.6.0_45/jre/lib/modules/jdk.boot.jar:/usr/lib/jvm/jdk1.6.0_45/jre/classes
sun.boot.library.path=/usr/lib/jvm/jdk1.6.0_45/jre/lib/amd64
sun.cpu.endian=little
sun.cpu.isalist=
sun.desktop=gnome
sun.io.unicode.encoding=UnicodeLittle
sun.java.command={home}/Development/oepe-indigo//plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar -os linux -ws gtk -arch x86_64 -showsplash -launcher {home}/Development/oepe-indigo/eclipse -name Eclipse --launcher.library {home}/Development/oepe-indigo//plugins/org.eclipse.equinox.launcher.gtk.linux.x86_64_1.1.100.v20110505/eclipse_1407.so -startup {home}/Development/oepe-indigo//plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar --launcher.overrideVmargs -exitdata 1e418010 -vm /usr/bin/java -vmargs -Xms256m -Xmx768m -XX:MaxPermSize=512m -Dsun.lang.ClassLoader.allowArraySyntax=true -Dweblogic.home={home}/Oracle/Middleware/wlserver_10.3 -Dharvester.home={home}/Oracle/Middleware/Oracle_OSB1/harvester -Dosb.home={home}/Oracle/Middleware/Oracle_OSB1 -Dosgi.bundlefile.limit=750 -Dosgi.nl=en_US -Dmiddleware.home={home}/Oracle/Middleware -jar {home}/Development/oepe-indigo//plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar
sun.java.launcher=SUN_STANDARD
sun.jnu.encoding=UTF-8
sun.lang.ClassLoader.allowArraySyntax=true
sun.management.compiler=HotSpot 64-Bit Tiered Compilers
sun.os.patch.level=unknown
svnkit.http.methods=Basic
svnkit.library.gnome-keyring.enabled=false
user.country=AR
user.dir={home}/Development/oepe-indigo
user.home={home}
user.language=es
user.name={username}
user.timezone=America/Argentina/Buenos_Aires
weblogic.home={home}/Oracle/Middleware/wlserver_10.3
Thanks!!

run this one in command prompt and then convert the applet using converter tool
JC_HOME = C:\java_card_kit-2_2_2\bin\
set CLASSES=%JCHOME%\lib\apduio.jar;%JC_HOME%\lib\apdutool.jar;%JC_HOME%\lib\jcwde.jar;%JC_HOME%\lib\converter.jar;%JC_HOME%\lib\scriptgen.jar;%JC_HOME%\lib\offcardverifier.jar;%JC_HOME%\lib\api.jar;%JC_HOME%\lib\installer.jar;%JC_HOME%\lib\capdump.jar;
D:\NareshPalle\jcardRE\Smart\src>java -classpath %_CLASSES% com.sun.javacard.con
verter.Converter -out EXP JCA CAP -exportpath .\exp -applet 0x0a:0x00:0x00:0x00:0x0e:0x01:0x02:
0x03:0x04:0x05:0x06 PackageName appletName 0x01:0x02:0x03:0x04:0x05:0x0
6:0x07:0x08 1.0
or
go to following directory and run the converter tool in command prompt
step 1: cd C:\java_card_kit-2_2_2\bin\
then run this command under the above directory
step 2:converter -classdir E:\Pathof Your applet class file -out EXP JCA CAP -exportpath E:\path of exp files folder -applet AID PackageName AppletName PackAID major.minor no
For more doubts mail me....
*[removed by moderator]*
Thanks and Regards
NareshPalle
Edited by: EJP on 31/03/2012 20:09: removed your email address. Unless you like spam and unless you think these forums are provided for your personal benefit only, posting an email address here serves no useful purpose whatsoever.

DocFlex/Javadoc 1.5.6, a multi-format doclet development tool and more

DocFlex/Javadoc is both a multi-format Javadoc Doclet and a rapid doclet development tool, which allows easy creation of professional quality Java API documentation generated by Javadoc in various output formats.
More in this article:
Key Features
Availability
This Version
What is DocFlex?
Main Concepts
Other Applications
Links
KEY FEATURES
Template-driven doclet architecture
- Actual doclets are created in the form of special templates interpreted by the DocFlex Doclet, which is the template interpreter / output generator wrapped in the form of a Javadoc Doclet.
- The high quality graphic Template Designer allows you to visually design most of things, whose development was possible so far only by direct Java coding.
- The templates are designed independently on a particular output format. All formatting is specified in some universal way using properties of template components. During the generation, it is rendered with the suitable features available in the selected output format.
- The elaborated support of template parameters (including multivalued list parameters). The parameters are defined and accessed within templates to adjust dynamic properties of template components. Most of options previously used to control an ordinary doclet now simply become template parameters!
- The possibility to call templates from one another. This feature (along with the template parameters) makes possible re-using the same templates for different tasks as well as organizing template libraries.
Data processing
- The entire Doclet API is represented in the form of a virtual XML document (called Doclet DSM), on which the designing and processing of all templates is based.
- Sophisticated capabilities for data querying and sorting based on an extension of XPath.
- Full support of new Java 5.0 language features: Generic Types, Enums, Annotations.
- Simultaneous support of Java 1.4 and Java 5.
Creating hyperlinks
- Generation of an extensive network of hyperlinks interconnecting the whole documentation.
- The hyperlinks can be generated in all output formats that support them (this currently includes HTML and RTF).
- The universal way of defining documentation cross-links based on the link/target keys specified in templates.
- In RTF, the cross-links can be generated in the form of page number references, which effectively makes them usable even in the printed documentation.
- In HTML, the possibility of loading several frame windows from a single hyperlink at once.
Universal support of various formatting techniques
- text formatting: fonts, colors, borders
- paragraph formatting: margins, pagination control, borders, colors
- border formatting: styles (solid, double, dashed, dotted), thickness, colors
- tables: arbitrary cell layouts, borders, nested tables
- lists: bulleted, numbered, delimited
- document fields (RTF): page number, number of pages, TOC, etc.
- page formatting: size, orientation, margins, headers/footers
- formatting styles
- rendering of embedded HTML, which means interpreting in non-HTML output formats (such as RTF) the HTML tags embedded in text data (e.g. documentation comments). Almost all HTML tags practically usable in doc-comments are supported.
Inserting images
- statically specified in templates
- dynamically, obtained by <img> tags found in Java comments
- supported image formats: GIF, PNG, JPG, WMF, EMF, BMP
Output formats
- HTML (both framed multi-file and single-file output)
- RTF (version 1.6 - supported since Word 2000).
- TXT (plain text), which may be particularly useful for various utilizations of the Java code information provided by the Doclet API generate XML files by it, or SQL files to import into a database).
Standard Template Set
- The ready-to-use Standard Template Set included in all editions of DocFlex/Javadoc allows you to immediately generate:
(*) The framed HTML Java API documentation similar to that generated by the standard Javadoc.
(*) The same documentation packed in a single HTML file.
(*) The unmatched quality RTF JavaDoc.
- Special features supported by standard templates:
(*) Excluding classes/methods/fields by custom tags and annotations.
(*) Selective omitting of package qualifiers.
(*) Selective documenting of custom tags (similar to -tag option of Standard Doclet).
- By modifying the standard templates, you can quickly customize the generated documentation according to your needs.
Doclet GUI
- Besides command line options, DocFlex Doclet supports an alternative user-friendly way to control the template-based doclets interactively -- the high quality Doclet GUI.
- The Doclet GUI starts with the Generator Dialog, where you can specify all general settings (such as the main template, the output format and the output directory), start the generation, track its progress and stop at any moment you need.
- The grid-tree-based Parameter Inspector invoked from the Generator Dialog for a selected template allows you to view the descriptions of all template parameters controlling the doclet and set their values according to the parameter data types.
- The generator options specific for the selected output format can be set in the corresponding Format Option Inspector (also invoked from the Generator Dialog).
- Once the generation is finished (or cancelled), you can start it again with different settings or a new main template without restarting the whole Javadoc.
Integrations
- With any system that runs Javadoc (in particular, see below)
- Apache Ant
- Apache Maven 2
- Eclipse
For lots more information, see DocFlex/Javadoc homepage: [http://www.filigris.com/products/docflex_javadoc/]
AVAILABILITY
DocFlex/Javadoc comes in two editions:
(1) The full edition called "DocFlex/Javadoc" as it is. This is commercial software, which includes all the implemented functionality.
(2) The reduced freeware edition called "DocFlex/Doclet". It includes only the output generator and can be used as an interpretor of any custom templates. It also includes the standard template set, which allows you to instantly use it as an HTML doclet (similar to the standard one, however with some special features) plus an excellent quality RTF doclet.
Both editions are available for downloads on the page: [http://www.filigris.com/downloads/]
THIS VERSION
New features:
- The template interpretor works 15-20% faster
- Improvement of RTF output
- Multi-valued (list) template parameters
- Custom elements
- Standard Templates: Selective documenting of custom tags (similar to -tag option of standard doclet)
For more details, see product Readme | Change Log on the downloads page: [http://www.filigris.com/downloads/]
WHAT IS DOCFLEX?
DocFlex is an innovative technology for development of high quality template-driven documentation/report generators by any kind of data obtained from various software applications via the Java APIs they provide.
MAIN CONCEPTS
The whole DocFlex technology is based on four generalizations:
(1) The mapping of an entire Java API onto a virtual XML-like representation made of some elements and attributes so as to process any such a representation in a universal way using techniques borrowed from the field of XML, like XPath (or more precisely, a conceptual analogue of XPath with some extensions not present in it).
(2) The abstract formatting concept based on four layouts (flow of text, flow of paragraphs or paragraph-like objects, tables and lists), which can be rendered in most modern document formats (e.g. HTML, RTF, XSL-FO etc.)
(3) The automatic generation of hyperlinks (or their page number reference equivalents) by matching the sets of keys produced from certain natural properties of the things (entities) being documented and hyper-linked.
(4) The representation of the object controlling structure of the output generator (made on the first three principles) in the form of a plain-text template with a possibility to create and edit such templates using a graphic Template Designer, which visualizes the controlling objects (now becoming template components) in a form resembling the output they will produce.
OTHER APPLICATIONS
In fact, DocFlex/Javadoc is not the only application of DocFlex technology. The following is a summary of other DocFlex software:
DocFlex/XML
The SDK and runtime environment for rapid development and execution of template-driven automatic documentation/report generators by any data obtained from XML files.
This is currently the most complex and advanced application of DocFlex technology. Actually, this tool can be considered a powerful alternative to XSLT. At least, it is definitely able to do what XSLT apparently not (for example, see XSDDoc below). We will publish a more detailed comparison DocFlex/XML versus XSLT with the next DocFlex/XML release, which is coming very soon.
DocFlex/XML home page: [http://www.filigris.com/products/docflex_xml/]
DocFlex/XML | XSDDoc
A template set for DocFlex/XML that implements a high quality W3C XML Schema documentation generator in HTML and RTF output formats.
For more details, please see: [http://www.filigris.com/products/docflex_xml/xsddoc/]
DocFlex/XML | WSDLDoc
A similar template set for DocFlex/XML that will implement a high-end WSDL documentation generator.
This product is not released yet.
DocFlex/Together
A template-driven documentation generator for [Borland Together|http://www.borland.com/us/products/together/] (which is a UML modeling tool).
This is the earliest application of DocFlex technology and probably the most beautiful one. It works only with Together Architect 1.x, which is now obsolete. Unfortunately, since Together 2005, Borland eliminated any open APIs (for unknown reasons). Because of this, further development of DocFlex/Together was impossible.
DocFlex/Together home page: [http://www.filigris.com/products/docflex_together/]
See also examples of the UML documentation generated with it: [http://www.filigris.com/products/docflex_together/examples/]
The future DocFlex/UML is going to generate something like this as well.
DocFlex/UML
A template-driven UML documentation generator based on [Eclipse EMF|http://www.eclipse.org/emf/]. This tool is in early development stage yet. In a sense, it will continue DocFlex/Together with the focus on integration with other UML tools that use Eclipse EMF.
LINKS
This original article can be found at:
[http://www.filigris.com/ann/docflex_javadoc_v1.5.6/]
DocFlex/Javadoc home page:
[http://www.filigris.com/products/docflex_javadoc/]
DocFlex/XML home page:
[http://www.filigris.com/products/docflex_xml/]
DocFlex/XML | XSDDoc, the XML schema documentation generator:
[http://www.filigris.com/products/docflex_xml/xsddoc/]
Free downloads:
[http://www.filigris.com/downloads/]

Now, DocFlex/Javadoc v1.4 has been released specifically dedicated to Linux (Mac OS X) support:
(*) Some early bugs have been fixed, which prevented it working properly under Linux.
(*) A special RTF option was introduced to generate OpenOffice.org friendly RTF (see below)
(*) Improved support for external document viewers.
(*) Now, DocFlex/Javadoc software includes the shell script files prepared to quickly install and launch it under Linux
New RTF option
A new RTF output option "Tune output for MS Word� has been introduced. This option, actually, allows switching off that very tuning (which until now was the default mode) to produce an RTF friendly to open with other non MS Word applications, e.g. OpenOffice.org Writer under Linux.
Read full announcement (and screenshot) by this link:
http://www.filigris.com/ann/docflex_javadoc_v1.4/
Regards,
Leonid Rudy
http://www.docflex.com

Export OSB configuration from eclipse using ant script

I am trying to export an OSB project from eclipse using ant script
I followed the link below http://biemond.blogspot.com/2010/07/osb-11g-ant-deployment-scripts.html
It is using com.bea.alsb.core.ConfigExport to do the export. This export is always set to resource level.
I see it generates a file ExportInfo setting some properties. It has a property that set the export level as below
<imp:property name="projectLevelExport" value="false"/>*
How can I export the project in project level? basically setting projectLevelExport to true?
So that if a file does not exist in the sbconfig.jar file , then while importing the jar to OSB server it will delete the file from the server instead of skipping it?
I appreciate any help
here is the ant script snippet that gets executed to export from eclipse
<target name="exportFromWorkspace">
     <delete failonerror="false" includeemptydirs="true"
dir="${metadata.dir}"/>
               
<java dir="${eclipse.home}"
jar="${eclipse.home}/plugins/org.eclipse.equinox.launcher_1.1.0.v20100507.jar"
fork="true" failonerror="true" maxmemory="768m">
<jvmarg line="-XX:MaxPermSize=256m"/>
<arg line="-data ${workspace.dir}"/>
<arg line="-application com.bea.alsb.core.ConfigExport"/>
<arg line="-configProject ${config.project}"/>
<arg line="-configJar ${config.jar}"/>
<arg line="-configSubProjects ${config.subprojects}"/>
          <arg line="-exportLevel true"/>
<arg line="-includeDependencies ${config.includeDependencies}"/>
<sysproperty key="weblogic.home" value="${weblogic.home}"/>
<sysproperty key="osb.home" value="${osb.home}"/>
<sysproperty key="osgi.bundlefile.limit" value="500"/>
<sysproperty key="harvester.home" value="${osb.home}/harvester"/>
<sysproperty key="osgi.nl" value="en_US"/>
<sysproperty key="sun.lang.ClassLoader.allowArraySyntax" value="true"/>
</java>
</target>

yes, I specified the project name to export the whole project.
Here is few lines from my properties file
# properties for workspace export
config.project="OSB Configuration-GW"
config.jar=D:/workspace/osb/scripts/gateway/mycode2/ant_osb/dist/sbconfig.jar
config.subprojects="GatewaySecurity"
config.includeDependencies=true
workspace.dir=D:/workspace/osb/gateway-workspace
But this property does not make it to export at project level ,it export the specified project at resource level.
And while importing this jar to OSB server, if a file is missing it skips the file instead of deleting the file from the OSB server
If I unjar sbconfig.jar file, open ExportInfo file and update the line in bold below to true then it deletes the file from OSB server, if not exist in sbconfig.jar
<imp:property name="exporttime" value="Thu Dec 29 13:57:44 EST 2011"/>
<imp:property name="productname" value="Oracle Service Bus"/>
<imp:property name="productversion" value="11.1.1.4"/>
*<imp:property name="projectLevelExport" value="false"/>*
Here is few lines from Oracle API java doc
http://docs.oracle.com/cd/E13171_01/alsb/docs26/javadoc/com/bea/wli/sb/management/importexport/ALSBImportOperation.Operation.html
public static final ALSBImportOperation.Operation Delete
Indicates that the resource is deleted in the importing domain. This is the default operation when the project is exported in its entirety and the resource exists in the target domain but not in the jar file
public static final ALSBImportOperation.Operation Skip
Indicates that the resource is skipped meaning the resource is not touched in the importing domain. This is the default operation if the jar file was exported at the resource level, and a resource that exists in the target domain, does not exist in the jar file.

How to use webui ui:upload in eclipse 3.2

Hi,
I would like to use file upload using sun products.
I tried with <ui:upload> but i am not able to render that component.
my jsf:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<%@ taglib uri="http://www.sun.com/web/ui" prefix="ui"%>
<f:view>
<html>
<head>
<title>Portfolio Analyzer</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" href="css/menu.css" />
<link rel="stylesheet" type="text/css" href="css/stylesheet.css" />
</head>
        <ui:page id="page1">
            <ui:html id="html1">
                <ui:body id="body1">
                    <ui:form id="form1">
                        <ui:upload id="fileUpload1" />
                    </ui:form>
                </ui:body>
            </ui:html>
        </ui:page>
</html>
</f:view>my web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app id="WebApp_ID" version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
     <display-name>
     GPJ</display-name>
     <context-param>
        <param-name>javax.faces.CONFIG_FILES</param-name>
        <param-value>/WEB-INF/faces-config.xml</param-value>
    </context-param>
      <context-param>
        <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
        <param-value>server</param-value>
    </context-param>
    <context-param>
        <param-name>org.apache.myfaces.ALLOW_JAVASCRIPT</param-name>
        <param-value>true</param-value>
        
    </context-param>
     
    <filter>
      <filter-name>UploadFilter</filter-name>
      <filter-class>com.sun.rave.web.ui.util.UploadFilter</filter-class>
      <init-param>
        <description>
          The maximum allowed upload size in bytes. If this is set
          to a negative value, there is no maximum. The default
          value is 1000000.
        </description>
        <param-name>maxSize</param-name>
        <param-value>1000000</param-value>
      </init-param>
      <init-param>
        <description>
          The size (in bytes) of an uploaded file which, if it is
          exceeded, will cause the file to be written directly to
          disk instead of stored in memory. Files smaller than or
          equal to this size will be stored in memory. The default
          value is 4096.
        </description>
        <param-name>sizeThreshold</param-name>
        <param-value>4096</param-value>
      </init-param>
</filter>
    <filter-mapping>
      <filter-name>UploadFilter</filter-name>
      <servlet-name>Faces Servlet</servlet-name>
    </filter-mapping>

<servlet>
     <servlet-name>Faces Servlet</servlet-name>
     <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
     <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
     <servlet-name>Faces Servlet</servlet-name>
     <url-pattern>/faces/*</url-pattern>
</servlet-mapping>

<welcome-file-list>
        <welcome-file>faces/addCampaignGroup.jsp</welcome-file>
</welcome-file-list>

<login-config>
<auth-method>BASIC</auth-method>
</login-config>



<listener>
<listener-class>com.sun.faces.config.ConfigureListener</listener-class>
</listener>
</web-app>I think i have some problem with my web.xml
Could anyone pls help me regarding.
Thanks,
Ambika.

I just tested it at my Eclipse environment. It was set to UTF-8 and the following line was not allowed:
String 試験 = "試験";When I set the encoding to UTF-16, it was accepted. If you still fails in this somehow, consult the eclipse boys, as said before.
However. In name of reusability I don't recommend to use other languages than English thoroughout the whole Java code. Maybe only in javadocs. But still, English is preferred over all other languages. The core Java API itself is also all in English.

Using Java to open a dialog box belonging to Eclipse

Hi there,
When I go into eclipse I can click on "Project" and then "Generate JavaDoc" which brings up a dialog box for me. Is there a way that I can write a program that opens this dialog box?
Any help would be much appreciated,
Thanks for your time,
beccy

mouse listener on the tree, see if the click count is 2 and what node it clicked, open the dialog. MouseEvent can give you the click count and x/y coordinate, JTree can tell you what node is at that coordinate.

How to use shift_jis encoding in eclipse 3.2???

i can't use shift_jis encoding in eclipse 3.2
how to add this encoding to eclipse????
please help me

I just tested it at my Eclipse environment. It was set to UTF-8 and the following line was not allowed:
String 試験 = "試験";When I set the encoding to UTF-16, it was accepted. If you still fails in this somehow, consult the eclipse boys, as said before.
However. In name of reusability I don't recommend to use other languages than English thoroughout the whole Java code. Maybe only in javadocs. But still, English is preferred over all other languages. The core Java API itself is also all in English.

Keep javadoc comments in class files

Hi there,
is there a way to keep javadoc comments in classfiles?
Reason: Not any company can spread the source for their algorithms, but as customer requests grow to use it with eclipse, code completion and javadoc, there is a need for such "feature".
Any ideas? Not documented tricks?
Ty

Ty, for you reply - this in response ... maybe you can support it ;-)
Your report has been assigned an internal review ID of 719676,
which is NOT visible on the Sun Developer Network (SDN).

XMLExportFormat and Crystal Reports for Eclipse 2.0

Hello,
I found this example code on the Crystal Reports for Eclipse wiki but can't find XMLExportFormat(s) classes in any jar. XMLExportFormatOptions is still referenced in javadoc even if it is useless as it needs the above mentioned classes.
I really need to export to default XML (as we used to do it in Crystal "save as..." menu) because those files are post-processed. Any hint ? Where can I find those classes ?
1. Create a new XMLExportFormatOptions object.
IXMLExportFormat xmlExportFormat = new XMLExportFormat();
XMLExportFormats xmlExportFormats = new XMLExportFormats();
IXMLExportFormatOptions xmlExpFormatOpts = new XMLExportFormatOptions();
2. Use the PrintOutputController class to get the list of XML export format types saved with the report.
xmlExportFormats = rcd.getPrintOutputController().getSavedXMLExportFormats();
int index = xmlExportFormats.getDefaultExportSelection();
xmlExpFormatOpts.setXMLExportSelection(index);
xmlExportFormat = xmlExportFormats.getXMLExportFormat(index);
3. Create an XMLExportFormatOptions object and set the export format type to XML.
IExportOptions expOpts = new ExportOptions();
expOpts.setExportFormatType(ReportExportFormat.XML);
4. Apply the XML export options.
expOpts.setFormatOptions(xmlExpFormatOpts);
5. Creates a new file with the specified path, name, and file extension.
String xmlPath = "C:
" + rcd.displayName() + "_" + xmlExportFormat.getName() + "." + xmlExportFormat.getFileExtension();
FileOutputStream fs = new FileOutputStream(xmlPath);
6. Creates a new ByteArrayInputStream object, streams the file using the Write method, and closes the stream.
ByteArrayInputStream byteIS = (ByteArrayInputStream)rcd.getPrintOutputController().export(expOpts);
byte[] buf = new byte[2000 * 1024];
int nRead = 0;
int maxSize = buf.length;
while ((nRead = byteIS.read(buf)) != -1)
fs.write(buf, 0, maxSize);
fs.close();

I found the code at that url:
https://www.sdn.sap.com/irj/boc/sdklibrary
Go to "Report Application Server Java SDK Developer Guide" link. It's a zip file.
In the zip file you can go right up to topic93.html
I found another example here:
https://www.sdn.sap.com/irj/scn/go/portal/prtroot/docs/webcontent/uuid/f0aea666-5384-2b10-ffb0-a6facef1d5e5 [original link is broken]
See example under "Java_RAS-Managed_BE12_Export_XML"
Anyway, I've never used Crystal till now and I'm totally lost in all those libraries. I found examples but on those example pages there are never links to libraries neither references to versions. So I just downloaded Crystal Report for Eclipse 2.0 but the examples didn't compile because classes in these examples don't exist. (!?) Please, don't tell me about "you can do that or you can not do that with version X or version Y" but give me a hint on what I need to run these examples and where to find it, or simply how I can output a report to xml.
(forgive bad english)
Thanks for your help,
Fabrice

Extract information from Javadoc files

I want to extract class, method & parameter information from the javadoc files (in html format, not from source code).
Are there any existing API's / opensource projects that would help me do this.
I have tried searching google and the forums, but I end up finding results related to extracting javadoc info from the source files. However I am interested in recovering this information from the generated HTML files.
Any pointers would be helpful.
- Ajay

The situation is like this: I have a stub jar file alongwith the documentation in HTML form. The classes in the jar file do not have any debug information so eclipse can not extract any parameter name information from the jar file. It does extract some info from the documentation, but quite a lot of the variables are still not named.
It becomes a tedious job to work with the API when you can not figure out which parameter refers to what. I have to often lookup the documentation to figure it out.
My plan is to recreate the stub jar by decompiling it and merging the parameter name information derived from the html documentation to create create source files. Then I can recompile them with debugging enabled to generate class files.
Any ideas or open source projects that would let me do this quickly?

Javadocs in Eclipse

Similar Messages

Maybe you are looking for