所有问题: [javadoc]

132 个问题

类似标签:maven-javadoc-plugin
3
投票
1答案
549 次观看

如何使Javadoc包含子项目的文档?

我在Netbeans中有两个紧密联系的项目。它们是单独的项目,因为其中一个项目是util软件包,将来可能会用于另一个项目。有没有一种配置Netbeans的方法,以便为主项目生成的Javadoc将包括指向util项目中定义的对象的链接,而不是列出完整的软件包路径? 编辑:我已经找到了操作方法。在项目属性>构建>文档中,您可以设置其他Javadoc选项。使用的选项是-link,然后是文档目录的URL。但是,我只能使它与绝对链接一起使用,并且在获取相对链接正常工作。 -link file:///A:\B\C\Util\dist\javadoc //this works -l...

10
投票
6答案
2280 次观看

在线有中央的javadoc存储库吗?

我发现一些示例代码使用了名为com.sun.jersey.spi.container.ContainerRequestFilter的接口。有人很好地发布了Javadoc 这里,但看起来好像是某位大学教授也找不到Javadocs。我知道我可以自己构建它,但是宁愿不完成工作。是否有获取此类Javadocs的中心位置? 我在此处和此处,第一个已关闭,第二个仅是精美的Google搜索。

6
投票
1答案
2835 次观看

Maven网站插件未在多模块项目中部署子项目或生成index.html

我有一个要为其部署站点的多模块项目,但是看来我的站点部署配置没有被子项目的子模块继承。 父母 moduleA moduleB 在文件系统上,它们彼此相对放置: /parent/ /moduleA/ /moduleB/ 当我跑步时: mvn site-deploy -P documentation 我的父项目已正确部署到: scp:// devServer / documentation / webwars / 但是,如果子模块继承父发行管理,则不会像我期望的那样部署任何子项目(例如moduleA或moduleB): ...

4
投票
2答案
3685 次观看

用于Maven Javadoc生成的UmlGraph vs APIViz

我想知道是否有明确的理由选择 UmlGraph 而不是 APIViz 用于在Maven2构建中生成Javadoc UML图。彼此之间是否有任何集成或功能,它们看起来很相似?

3
投票
3答案
3938 次观看

一个开源工具,可通过Maven2使用ydoc之类的自动UML图生成Javadocs

我想通过maven的站点生成插件生成javadocs,并且希望在Javadoc中创建并嵌入自动UML图。 statsvn 项目使用 yDoc 来生成他们的UML文档,但我认为他们正在使用Maven1。 yDoc是一种商业共享软件产品,因此我不确定开源statsvn项目如何与它集成(或者是否有用于Javadoc生成的免费版本)。 svnstat yDoc javadoc示例: ChurnPageMaker.java svnstat包含ydoc作为其Maven1报告生成的插件: 项目。 xml <reports> &lt...

4
投票
1答案
940 次观看

是否有将Javadoc转换为C#XML文档的工具?

有人知道将Javadoc注释转换为C#文档注释的工具吗?

323
投票
4答案
125366 次观看

如何在javadoc中添加对方法参数的引用?

是否可以从方法文档主体中添加对一个或多个方法参数的引用? 像这样: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void foo(String a, int b) {...}

44
投票
4答案
18051 次观看

如何使生成的类包含XML Schema文档中的Javadoc

我目前正在使用XML模式,该模式在大多数类型和元素上具有<xsd:annotation>/<xsd:documentation>。当我从此XML模式生成Java Bean时,这些Bean的Javadoc仅包含一些有关类型/元素的允许内容的通用生成信息。 我想在相关位置查看<xsd:documentation>标签的内容(例如,complextType的该标签的内容应显示在代表该complexType的类的Javadoc中)。 有什么办法可以做到这一点? 编辑:此XML架构将在具有JAX-WS的WSDL中使用,因此此标记也可能适用。 编辑2 ...

3
投票
4答案
99 次观看

第三方Javadoc怎么办

希望了解其他人如何处理第三方(供应商)java文档?是否将它们置于源代码控制之下,以便每个人都可以访问它们?放在本地共享目录上?人们必须工作的其他解决方案。 我们使用clearcase,并让开发人员与几个离岸团队一起在美国分布。

1
投票
1答案
255 次观看

有没有办法在javadocs中包含正文注释?

我们有一个大型的Java代码库(其中混入了少量的Groovy),基本上没有为此编写Java文档。 但是,大部分代码在散布在整个身体中的“老式”注释中都得到了很好的记录。 我们现在正在努力尝试使文档更好地进行记录-例如,现在定期生成Javadocs。作为权宜之计,如果javadoc将“刮除”类的主体(或函数或其他内容)并将其中的所有注释扔入“存根” javadoc中,那将是非常好的。 有办法吗?

10
投票
5答案
17063 次观看

生成javadoc作为word文档

我们如何将javadoc生成为word文档而不是传统的html页面?

2
投票
2答案
1009 次观看

Annotations complement javadoc tags

Why is it said that Annotations complement javadoc tags?

1
投票
1答案
385 次观看

Is there a way to define 'javadoc types' - custom parameters for members?

The use case I can think of is the following: In a typical application, there are usually many members of a certain category, e.g., a web application contains many constants attribute keys, Action classes, services, etc. For each category, to maintain consistency, it is useful to document them c...

8
投票
3答案
16314 次观看

JavaDoc plugin for eclipse?

I was looking for a javadoc plugin for eclipse so that I can document for methods etc. I know in eclipse you can do ALT + SHIFT + J but I was wondering if there was a more powerful plugin. I use GhostDoc in VS 2008 which basically when you say document it enters all the parameters and return va...

2
投票
1答案
1684 次观看

Adding dynamic links to JavaDoc within Maven Site generated html

I am wondering if there is a way through the maven site plugin to have it automatically create a link to some JavaDoc structure (like a class) within the html it generates. As an example of what I mean, Doxygen provides a way to do this through using the doxy protocol. You can create an anchor ...

0
投票
4答案
3062 次观看

Writing a java code which will execute every hour(quartz)

Can someone please correct me, I've found this example online and bunch of others not working, this particular example throws the following error : Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/commons/collections/SetUtils at org.quartz.JobDetail.<init>(JobDeta...

14
投票
3答案
10274 次观看

How to turn off the Javadoc hover in Eclipse (or selectively enable it)?

A fellow developer dislikes the Eclipse hovering Javadoc and would like to disable it (one option), or, better yet, only selectively enable it (other option). He's using Eclipse 3.3. Is this possible?

3
投票
1答案
540 次观看

How can I prevent a package-private interface appearing in Javadoc?

I've got a class like this: package org.jjerms.thing; interface IThing { void doSomething(); } final class Thing implements IThing { /** * This Javadoc pretends (to users outside the package) * that doSomething originates here. */ public void doSomething() { ...

5
投票
3答案
10887 次观看

Maven include JavaDoc Jar in Assembly

I have a project with multiple modules, including on that is responsible for building the final assembly from the artifacts of the other modules. As part of the assembly, I want to include the JavaDocs for two of the other modules. I have updated the pom files for those modules to generate the ...

121
投票
3答案
39517 次观看

How to @link to a Enum Value using Javadoc

Using Javadoc 1.5, I have been unable to create a @link to an Enumeration value. What I would like to do is to create an Enum like this: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** * Ot...

28
投票
1答案
13153 次观看

What's the correct way to include an email within Javadoc?

I like to put my email address within @author tags and would like them to be clickable mailto: links in the generated Javadoc. How should I go about doing this correctly? /** * I currently do the following, but would like to have my name * displayed as the link rather than the email itself. ...

1
投票
2答案
2431 次观看

How to set javadoc path for a jar in a project using Eclipse

I'm using JUnit 3 in Eclipse Galileo. The junit.jar (located in the project in vendor/lib/) contains both the classes and the javadoc. In my project which I share using CVS, I want the doc to be available for everybody who checks-out the project. So I committed the .classpath file. When adding t...

29
投票
3答案
24553 次观看

JavaDoc Style Sheets

I was wondering. Do any of you have a JavaDoc style sheet? The default one is pretty ugly. Thanks!

8
投票
2答案
22344 次观看

How to generate javadoc with ant, for an existing project?

I want to make a Javadoc from an ant build file, but I don't see where it is. In build.xml I have: <description> A sample build file for this project </description> <property name="source.dir" location="src"/> <property name="build.dir" location="bin"/> &l...

2
投票
1答案
954 次观看

I want to add JavaScripts in JavaDoc

/** * <div class="en">Documentation in English</div> * <div class="nl">Documentatie in Nederlands</div> */ public void myFunction() {} Subsequently edit the CSS of the JavaDocs so that the user can switch languages, e.g.: div.en { display:none; } div.nl { display:blo...

12
投票
2答案
6622 次观看

How to create multi-language JavaDocs?

There is JavaDoc of a normal Java API with an English edition and a Chinese edition, but it seems to require having separate source code for each edition. Is there any more convenient way to do this?

6
投票
2答案
1332 次观看

JavaDoc to (Doku)Wiki conversion / doclet

Our company has a very large public Java API which is currently being released standalone and online using (of course) JavaDoc. It is surrounded by product documentation which links into the API. We are moving our static documentation to DokuWiki - which works pretty good - and want to keep the...

11
投票
2答案
2169 次观看

Is there a javadoc replacement that uses a Wiki-like syntax?

Is there a tool replacing javadoc with something that is more Wiki-style syntax instead of the HTMLish syntax of normal JavaDoc? One of my problems is that I mostly read JavaDoc in source form. Even for external libraries I try to have the source attached so I can navigate into it from my IDE, c...

23
投票
7答案
11985 次观看

Javadoc Inserting UML Diagrams

Is there a way to embed images into my JavaDoc? Basically i want to include some UML diagrams explaining the hierarchy of my classes in some of the documentation. Thanks!

10
投票
5答案
2805 次观看

syntax highlighting for javadoc?

Currently I format code examples in my javadoc using the PRE tag e.g.: /** * Example javadoc * <pre> String foo = "bar"; </pre> * * @return true if the operation completed */ But this turns out rather monotone and boring in the resulting javadoc, I'd much rather have some syn...