javadoc

Autogenerated documentation for a mixed java/scala project

你说的曾经没有我的故事 提交于 2019-12-05 20:13:21
I'd love some advice on how best to autogenerate documentation for a mixed Java/Scala project. We're using Scala 2.8; it seems the scaladoc tool that ships with 2.8.1 does not generate usable documentation for our Java classes -- it gets the structure right, but does not include the documentation. And javadoc obviously only covers the Java part. We looked at Doxygen, but it doesn't work with Scala out of the box, so that's a bit of a research project. How can we do this short of going 100% Java or 100% Scala? Thanks! Play Framework generates scaladoc for its Scala classes and javadoc for its

generating javadoc as a word document

自闭症网瘾萝莉.ら 提交于 2019-12-05 20:11:56
问题 How can we generate javadoc as a word document instead of the traditional html pages? 回答1: look into doclets, http://doclet.com which have plenty of examples of custom javadoc rendering (i.e into PDF's etc...) and also look into Apache POI (http://poi.apache.org/) for the generation of MS Office files 回答2: If you could live with pdf instead of word, you should give PDFDoclet a chance. I discovered it on doclet.com (thanks to Mark for the link). It works quite well, is easy use and allows some

Javadoc error - java.lang.reflect.InvocationTargetException

你说的曾经没有我的故事 提交于 2019-12-05 18:19:12
I am trying to generate the uml diagram from yDoc library. It basically uses Javadoc to parse tha Java source files. However, when I am trying to execute the command from terminal(OS X), I am getting following error: javadoc: error - In doclet class ydoc.doclets.YStandard, method start has thrown an exception java.lang.reflect.InvocationTargetException java.lang.NoSuchMethodError: com.sun.tools.doclets.internal.toolkit.taglets.TagletManager. getConstructorCustomTags()[Lcom/sun/tools/doclets/internal/toolkit/taglets/Taglet; at ydoc.doclets.F$_A.<init>(Unknown Source) at ydoc.doclets.F.B(Unknown

gradle build Javadoc task fails with 'unknown tag: attr'

妖精的绣舞 提交于 2019-12-05 16:57:31
问题 I am attempting to build the android-autofittextview project from the command line using gradle. However, it fails every time with the following error: /Users/me/android-autofittextview/library/src/main/java/me/grantland/widget/AutofitHelper.java:384: error: unknown tag: attr * @attr ref android.R.styleable#TextView_textSize This error is repeated a dozen times in various files. This happens during the :library:androidJavadocs I tried turning it off using this approach, but then I get an

Manage source and javadoc for Grails automatic dependencies in IntelliJ IDEA?

眉间皱痕 提交于 2019-12-05 13:31:25
How do I attach source and javadoc to libraries in IntelliJ IDEA that are linked automatically by Grails dependency resolution and are not explicitly listed in the IDEA project settings? For example in BuildConfig.groovy : grails.project.dependency.resolution = { repositories { mavenRepo "http://oss.sonatype.org/content/repositories/releases/" } dependencies { runtime 'org.elasticsearch:elasticsearch:0.17.7' } } Is there a method to have IDEA automatically pick up the source and javadoc from the Maven repository? IDEA attached the source automatically to the project plugin module. The JavaDoc

Missing basic JavaDoc in Eclipse

徘徊边缘 提交于 2019-12-05 13:01:19
问题 Up to a few days ago, Eclipse was working fine in locating the javadoc for base classes such as Java.io.File. Recently, though, hovering over these classes only yields a message indicating that the source and javadoc are missing: "Note: This element has no attached source and the Javadoc could not be found in the attached Javadoc." I couldn't for the life of me locate the option that would let me reselect the location of the basic documentation. Does anyone know how to fix this? 回答1: Expand

Bad line breaking in Eclipse javadoc comments

五迷三道 提交于 2019-12-05 12:57:45
There's a minor but annoying bug, I think, in the Eclipse built-in Java formatter. I have a Javadoc comment that looks like this: /** * - - - stuff - - - {@code mTasksBelow}. */ where period at the end is in column 81. The formatter is set to wrap Javadoc comments at line 80. Unfortunately, when I format the code, it does this: /** * - - - stuff - - - {@code mTasksBelow} * . */ This puts white space between the text and the period in the generated output, so a browser rendering the Javadoc in HTML, for instance, will also think it's okay to break there. This doesn't seem to happen unless the

Killing Javadoc warnings for specific tags

半世苍凉 提交于 2019-12-05 12:43:05
问题 Is there an easy way / option of preventing javadoc warnings when building with Maven? We use the soyatec uml plugin for eclipse and it inserts special tags which make our builds throw lots of annoying warnings; I've looked around including on the soyatec site and have come up empty. @uml.property is an unknown tag 回答1: The only answer I could find to this is by Configuring Custom Javadoc Tags. An example could be like this: <build> <plugins> <plugin> <groupId>org.apache.maven.plugins<

Javadoc does not recognize doctitle option/flag

人盡茶涼 提交于 2019-12-05 12:01:49
I am running javadoc with my doclet through gradle, and when I am running my javadoc/doclet task, I am receiving the next error: error - invalid flag: -doctitle And after that, the next usage table usage: javadoc [options] [packagenames] [sourcefiles] [@files] -overview <file> Read overview documentation from HTML file -public Show only public classes and members -protected Show protected/public classes and members (default) -package Show package/protected/public classes and members -private Show all classes and members -help Display command line options and exit -doclet <class> Generate

JSON.simple API Javadoc

无人久伴 提交于 2019-12-05 11:51:50
问题 Is there a Javadoc for JSON.simple? 回答1: I generated the Javadoc from source and put it online. The project wiki has some interesting pages and version 1.0.2 also had an interesting README. 来源: https://stackoverflow.com/questions/2640309/json-simple-api-javadoc