Все вопросы: [javadoc]

132 вопросов

похожие теги: maven-javadoc-plugin
3
голосов
1ответов
549 просмотров

Как заставить Javadoc включать документацию для подпроекта?

У меня есть два тесно связанных проекта в Netbeans.Это отдельные проекты, потому что один из проектов представляет собой служебный пакет, который можно использовать в будущем для другого проекта.Есть ли способ настроить Netbeans таким образом, чтобы документация Javadoc, созданная для основного ...

10
голосов
6ответов
2280 просмотров

Есть ли в сети центральный репозиторий javadoc?

Я нашел образец кода, в котором используется интерфейс с именем com.sun.jersey.spi.container.ContainerRequestFilter.Кто-то был достаточно любезен, чтобы опубликовать javadoc здесь , но похоже, что это был какой-то университетский профессор, который тоже не смог найти javadocs.Я знаю, что могу п...

6
голосов
1ответов
2835 просмотров

Плагин сайта maven не развертывает подпроекты в многомодульном проекте и не генерирует index.html

У меня есть многомодульный проект, для которого я хочу развернуть сайт, но похоже, что моя конфигурация развертывания сайта не наследуется дочерними модулями подпроекта. родитель moduleA moduleB В файловой системе они расположены относительно друг друга: /parent/ /moduleA/ /m...

4
голосов
2ответов
3685 просмотров

UmlGraph против APIViz для создания документации Maven javadoc

Мне интересно, есть ли какие-нибудь явные причины для выбора UmlGraph вместо APIViz для создания диаграммы javadoc UML в сборке Maven2.Есть ли какая-то интеграция или функции, которые есть у одного над другим, они кажутся очень похожими?

3
голосов
3ответов
3938 просмотров

инструмент с открытым исходным кодом для создания документации Javadocs через Maven2 с автоматическими диаграммами UML, такими как ydoc

Я хочу создавать документы javadoc с помощью подключаемого модуля создания сайтов maven, и я хочу иметь автоматические диаграммы UML, созданные и встроенные в javadoc. В проекте statsvn используется yDoc для создания документации UML, но я думаю, что они используют Maven1. yDoc - это комм...

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 просмотров

Как сделать так, чтобы сгенерированные классы содержали Javadoc из документации XML Schema

В настоящее время я работаю со схемой XML, которая содержит <xsd:annotation>/<xsd:documentation> для большинства типов и элементов. Когда я генерирую Java Beans из этой XML-схемы, Javadoc этих Beans содержит только некоторую общую сгенерированную информацию о разрешенном содержимом т...

3
голосов
4ответов
99 просмотров

Что делать со сторонней документацией Javadoc

Хотите узнать, что другие делают со сторонними (поставщиками) java-документами? Помещены ли они под контроль версий, чтобы каждый мог получить к ним доступ? Размещено в локальном общем каталоге? другие решения, которые должны хорошо работать. Мы используем clearcase, и разработчики рассредото...

1
голосов
1ответов
255 просмотров

Есть ли способ включить текстовые комментарии в javadocs?

У нас есть большая кодовая база Java (с небольшим количеством примеси Groovy), для которой, по большому счету, нет документации javadoc. Однако большая часть кода достаточно хорошо документирована в комментариях "старой школы", разбросанных по всему тексту. Сейчас мы делаем что-то вроде то...

10
голосов
5ответов
17063 просмотров

создание javadoc в виде текстового документа

Как мы можем создать javadoc в виде текстового документа вместо традиционных 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...