print javadoc to one single file
Hello,
I was wondering if it is possible to print the whole javadoc documentation to one single file? The reason why I need this is that I would like print the API-documentation and import it in another document. I have about 600+ classes, so copying the files one by one is really my last resort :)
I browsed through the documentaiton, but I couldn't find anything useful. Do I need another doclet implementation? Anything that does the job is welcome, as long as it understands the JDK 1.5 features.
Thanks in advance.
Hi,
DocFlex/Doclet is supposed to do that job. It's able to generate a single RTF file (as well as HTML) of best quality with all classes at once. DocFlex/Doclet is a freeware edition of DocFlex/Javadoc, a template-driven tool with much more capabilities.
See: http://www.filigris.com/products/docflex_javadoc
Java 1.5 specific language features are not supported yet, but we are planning to release the next version 1.5 of this tool with full Java 1.5 support something in a month or so.
Regards,
Leonid Rudy
http://www.docflex.com
Hi,
Firstly, DocFlexDoclet is a VERY GOOD doclet tool, and I am in no way 'dissing' it! We all have different documentation requirements :-)
I am a Technical Author, not a programmer and I have been responsible for the development of our documentation, not code. I have been looking around for different doclets to try and implement different documentation strategies, but found that DocFlex was not a viable solution for what we required (or able to implement).
We regularly use MIFdoclet for implementing single printable documentation. However, to successfully use it, this does require you to have FrameMaker and DzBatcher installed, unless you can process Adobe MIF (Maker Interchange Format). To give you an idea of the extent of its use, using MIF doclet, I have successfully managed to generate documentation for part of our API, the resulting document is about 4,000 pages (yes, that抯 four thousand pages!). The doclet handled this fine, formatted it using our own templates and corporate styles, but most importantly, in did it in one printable file!
We also use MIF doclet to generate our corporate look and feel for single class files that we include in various sections throughout our doc set.
Hope the MIF doclet team keeps up the good work! Looking forward to any updates!
In addition to this doclet, I have looked at the RTFdoclet and PDF doclet, both of which achieve what you require.
More information about doclets and also 3rd party doclets can be found in the JavaDoc FAQ.
http://java.sun.com/j2se/javadoc/faq/#docletsfromthirdparties
Hope this helps as well?
Regards
Supersaus
Hello Supersaus,
I'm grateful a lot for your words about DocFlex/Doclet, but I would also appreciate to learn what exactly made it not a viable solution for you.
If you mean performance issues, I've just tried to generate with DocFlex/Doclet v1.2.10 (currently available) the documentation for the whole 'javax.swing' package with subpackages from Java SDK 1.4 sources.
On my computer (AMD Athlon64 3000+ based), it took 287 seconds to process everything and produce an RTF file of 21 Mb size, in which MS Word has encountered 3012 pages!
Actually, DocFlex/Doclet as well as the whole DocFlex/Javadoc are in a certain sense a by-product (however a lovable one) of the whole technology we develop, which is aimed to much wider purposes: the template-based generating reports/documentation from unlimited data sources with virtuoso formatting capabilities into interchangeable output formats.
Unlike MIFdoclet, which is said to be not supported anymore, DocFlex/Javadoc is being improved all the time, even with little doing anything specific about it. That's because 95% of DocFlex/Javadoc consists of the same core used in other DocFlex application and we do constantly work on this core all the time (to meet demands from other tasks).
Currently, our team consists of only programmers and we ourselves do write lots of code but few documentation. Therefore, it would be very valuable to hear from professional Technical Authors what exactly is needed for them.
At the moment, we have no our own forum web-site (though, it's planned in not so distant future). Please, write any opinion/ideas to our 'contact' e-mail at filigris.com or at this forum.
Thanks,
Leonid Rudy
http://www.doclet.com
... sorry, the last line in my message was a mistakeOur web-site URL is: http://www.docflex.com (or http://www.filigris.com)Leonid Rudy
Hi Leonid,
It's good to hear that you would value the opinions of professional Technical Authors, as all too often when reading through this and other forums, our opinions are overlooked.
There were a couple of factors that were considered before discontinuing with further investigations into your doclet.
In the first (and main) instance, we use FrameMaker as our main documentation tool. Whilst FrameMaker has a few small niggles, it is a very stable platform from which to base our documentation on. (IMHO) MS Word cannot compete with this stability, especially when it comes to disciplined use of templates.
The second was financial, in that we could not justify the expenditure when MIF doclet achieves the required results for virtually free. (template development cost only)
I think if we were using MS Word to produce our documentation, things may have been very different.
Regards
Supersaus
Hi Supersaus,
Thanks a lot for your reply!
It was real interesting to read.
Even though, by now, we have more than 300 trial license requests on DocFlex/Javadoc, most people actually behave very much like ghosts... Few are saying something about what they actually need (even those who eventually have purchased a license, by the way :) Many are looking for something on the net but few appear to know that the net would never learn or invent by itself what everyone needs...
So, as far as I understand, the main problem for you about DocFlex/Doclet is its destination output formats. This is actually encouraging for me, because DocFlex core was just designed and developed to be basically independent on any output formats at all (so are the templates, by the way). The particular output generators are relatively small extensions of the abstract generic one. The reason why HTML and RTF are supported first is mainly historical one.
Other destination formats are certainly coming. There should be no problem to develop a new destination format generator, since all modern formats in one or another form do support all basic formatting concepts, such as paragraphs, fonts, tables, lists and so on. And this would be just enough.
But which format should be supported first? This would be interesting to hear from the people who are consuming them. Should it be XSL FO, DocBook, PostScript, PDF or MIF? What people in the field would be most interested to see? What's the coolest thing?
Thanks,
Leonid Rudy
http://www.docflex.com
