FAQ Database Discussion Community


Generate Javadoc for OSGi bundle

apache-camel,javadoc,servicemix,osgi-bundle,maven-javadoc-plugin
I'm newbie in OSGi world but I was able to do some Camel and OSGi bundles to do some tasks in a middleware. Everything I made since was a proof of concept, but now I want to refactor some part of my code and I start writing a OSGi bundle...

IntelliJ Javadoc adding an additional asterisk every line

java,intellij-idea,javadoc
I'm having an obscure bug with IntelliJ javadoc formatting. Whenever I create a javadocor add a new line, it is adding a second asterisk after my cursor which is very annoying to deal with. Here's a gif of what happens when I try to write javadocs: http://gyazo.com/4f8cf0727e545715afe02658a08edbe1...

How to create multiple levels of indentations with different markings in Javadoc?

java,html,javadoc
This question comes from the fact that I try to recreate an already existing java docs document for learning purposes which has multiple levels of indentations where the next level of indentation has a different marking than the first one. I am trying to recreate this behavior. It should look...

Any way to make Groovydoc remove (selected) package qualifiers as per Javadoc's 'noqualifier' option?

ant,groovy,javadoc,groovydoc
I've just started generating Groovydoc for a library I'm working on. However, the preponderance of java.lang and java.util and other common package prefixes in the method signatures is obscuring the real intent of the methods. I'd like to be able to generate the Groovydoc without these. As in the (made...

Using Maven to create Javadocs as a zip file instead of a jar file

java,maven,zip,javadoc,maven-javadoc-plugin
I am trying to figure out how to create a zip file of my Javadocs instead of a jar file using Maven. I am currently creating a jar file using the maven-javadoc-plugin. <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.7</version> <executions> <execution> <id>attach-javadoc</id> <goals> <goal>jar</goal> </goals> </execution> </executions> </plugin> I looked at the goals...

Hiding Public Methods in Java API/Jar

java,android,methods,javadoc,hiding
I am preparing a Android Java Jar which has some public methods. My requirement is that I want to hide certain public methods in the jar, i.e. the developer should not be able to directly (He can in-directly use it through reflection) use these methods using the jar that I...

Enunciate reporting - How to Exclude few APIs and include few APIs from a same class

java,rest,documentation,javadoc,maven-javadoc-plugin
I would like to exclude few API methods in a class from Enunciate documentation. Is there a way to achieve it using enunciate ? Thanks in Advance...

RegEx to match specific javaDoc attribute in a CSS file, and extract data about the css defintion

php,css,regex,javadoc
Im trying to simply store some meta data about CSS styles, which our app can use to build menus that allow the user to select those styles (amongst other things). I thought the JavaDoc style comment was the best approach, and use a attribute like 'config' or similar. Then store...

Incomplete Javadoc in Java 8? [closed]

java,java-8,javadoc
Is the Javadocs for Java 8 incomplete? Some of the method comments are omitted and the method description is copied (incorrectly) from a base class (e.g. the java.util.IntSummaryStatistics toString() method with the note "Description copied from class: Object". public String toString() Description copied from class: Object Returns a string representation...

JavaDoc - Undeclared Type Variable

java,maven,java-8,javadoc
I think everybody who has to work with Maven and Java8 knows of this bug that release builds suddenly fail for spelling mistakes in JavaDoc. As a company we decided to let some poor sap (aka me) work all of them out. Now I'm stuck with the following "error": [ERROR]...

How to view Java-provided classes in Eclipse [duplicate]

java,javadoc,attachment
This question already has an answer here: How do I view JRE's source code in Eclipse? 10 answers How can I see for example the content(raw Java code) of DefaultTableModel.class in Eclipse? It says Source not Found and I tried to set it to a downloaded javadocs folder but...

Describe API purpose [duplicate]

java,eclipse,javadoc
This question already has an answer here: Custom index.html javadoc page? 2 answers I use eclipse.Normally we can use javadoc.exe to create HTML Doc in about packages, classes, methods, fields and ... that are in project.But how I can create a doc to describe purpose of whole of the...

how to generate correct javadoc reference?

java,eclipse,javadoc
Firstly forgive me if it is a dumb question:/ I tried to generate javadoc with Eclipse but the generated documentation does not have a hyperlink for @see @link tag. (I referenced a class within the same package) Then I checked the reference path for classes it appears empty when I...

JDK 1.7 allows custom taglets with names *starting* with a dot. JDK 1.8 forbids it?

java,java-8,javadoc,taglet
I've written a custom taglet library with names that start with a dot: .codelet, .codelet.and.out, etcetera. It is compiled with JDK 7. When generating JavaDoc using the 1.7 javadoc.exe, it works fine. But when generating it with JDK 8, it fails because C:\...\Temp.java:5: error: no tag name after @ *...

IntelliJ can't find jdk documentation even though when I visit the URL it works

java,oracle,intellij-idea,javadoc
When I try to view javadocs in Intellij 13 or 14, it doesn't work. I see this error message: Following external urls were checked: http://docs.oracle.com/javase/6/docs/api/java/sql/ResultSet.html#next() http://docs.oracle.com/javase/6/docs/api/java/sql/ResultSet.html#next-- The documentation for this element is not found. Please add all the needed paths to API docs in Project Settings. Yet, if you visit...

Regex for only the opening java doc comments [duplicate]

java,regex,javadoc
This question already has an answer here: Regex for matching javadoc fragments 2 answers I'm trying to write a regex that matches java doc comments within java files and my code below doesn't seem to be working. I'm specifically trying to match only the initial javadoc comments prior to...

proper javadoc comments for two classes

javadoc
Right now I have to write some comments for my code. The code is like: /** * Provide a block grid of customized size and * a block moving back and forth at the center * of the block grid. * @author .. * @version .. */ public class BlockGrid...

Check Comments/Javadoc number of words with Checkstyle

java,comments,javadoc,checkstyle
Is it possible to set up a checkstyle rule that will count the number of words from a commment and then shows a problem if the number of words is under a defined limit. I searched on the checkstyle Javadoc properties, but did not found something useful. For Example: /**...

How to keep IntelliJ IDEA from rearranging javadoc tags?

intellij-idea,javadoc,intellij-idea-14
/** * Comment. * * <p>Hello * * @author me ([email protected]) * @version $Id$ * @since 0.1 * @checkstyle ClassDataAbstractionCoupling (500 lines) * @checkstyle ClassFanOutComplexity (500 lines) */ When I reformat my code with Ctrl+Alt+L, the @since is placed after the @checkstyle tags. Is there any way to disable javadoc...

Is there a way to tell Gradle to include dependencies Javadocs in generated Javadocs?

java,groovy,gradle,javadoc,build.gradle
I have a Java project that I am managing with Gradle. Such project will be composed by multiple small libraries, which are developed independently one another, and a "leaf" project whose goal is just to depend on the latest stable version of each library, package everything in a fat Jar...

Javadoc formatting hyperlinks

java,formatting,javadoc
I can't seem to find out how to format my javadoc to show to show up with links to String rather than the whole path. I've gone through several different guides with no luck. I was hoping to make it look more in line with how documents at oracle look....

Javadoc for a New java maven project in eclipse

java,eclipse,maven,javadoc
I created a new Maven project and generated Javadocs through eclipse. It created a lot of html files in the project directory inside a folder called "doc". Now I want to distribute this project as a dependency to my colleague and he does not have the source of the project...

How do I document a method that returns a tuple in javadoc? [closed]

java,tuples,javadoc
How do I document in javadoc a method that returns a tuple? For example: public Tuple2<Double,Double> arcadeDrive(double moveValue, double rotateValue, boolean ... sqrdRooted){ //Code return new Tuple2<Double,Double>(leftMotorSpeed, -rightMotorSpeed); I know how to document the parameters and everything, but I'm not sure how I should be representing the tuple returned. So...

Javadoc : is it possible to avoid fully qualified names in package-info using {@link}

javadoc
When adding documentation to package-info.java I can't figure out a way to avoid using fully qualified names in {@link} comments. Having fully qualified names makes documentation much less readable in unformatted comments and formatted output. import doesn't work because we are in package-info.java has anyone else run into this issue...

How to _use_ a javadoc

java,eclipse,javadoc
I have a very basic question about javadocs - I apologize in advance, I'm completely unfamiliar with the topic and can't find an answer on google. I downloaded a certain implementation in java, and imported the downloaded projects in Eclipse. In the files that I needed, I found syntax that...

IntelliJ adds extra * every time I hit enter in a block comment

java,intellij-idea,javadoc,intellij-14
I'm having a super strange problem with Idea. Every time I hit enter in a block comment it adds an extra * on the line. It gets really annoying to have to delete it before typing each line. I have tried importing several coworkers code style settings who are not...

Sbt Publish Java8 Project to Sonatype - JavaDoc Failure on Java8 Features

sbt,java-8,javadoc,sonatype
Hey I'm having a problem publishing a Java8 SBT Project to Sonatype. When I run the publishSigned target, javadoc is complaining about Java8 features yet the code is compiling fine. If I put a scala file in the project, then scaladoc can compile it fine which is how I published...

How to get API documentation to be shown inside Eclipse Help window?

java,eclipse,reference,documentation,javadoc
I've downloaded jdk-8u45-docs-all.zip from here, wrote it's link to my jdk's javadoc location in Eclipse. Everything works just well, when I hover over something the tooltip appears, when I press shift+F2 offline API documentation opens in browser. The only thing that doesn't work - When I write some search query...

Do I need to @Nonnull again at the implementation?

java,annotations,javadoc,findbugs
While I think there should be a general rule for inheriting annotations or not, I'm specifically interested in making FindBugs recognize my rules, so this question is FindBugs specific. AFAIK, JavaDoc comments are taken from the interface and are ignored at the implementation. Does this concept also apply to annotations...

Javadoc: Do parameter and return need an explicit type description

java,types,javadoc
When Javadoc'ing, I don't know whether you should explicitly say whether the parameters are of type String or int. For example /** * This method does something * @param foo an object of type Foo * @param abc the number of doors, of type int * @return the number of...

What is the correct way to write javadoc in abstract methods

java,javadoc
public interface ISomething /** * This method does something! */ public void something(); } public abstract class AbstractSomething implements ISomething { /** * See {@link #doSomething()} */ public final void something() { doSomething(); // Do something else... ... } protected abstract void doSomething(); } public class ConcreteSomething extends AbstractSomething {...

Find methods without JavaDoc in IntelliJ?

intellij-idea,javadoc
In IntelliJ, is there a way to get a list of all methods without JavaDoc for a certain class? A package? A module? A project?...

Difference between java doc and Android doc in method documents

java,android,javadoc
Some times I see problematic differences between Java doc and Android doc in about method documents.For example in about setReadable (boolean readable, boolean ownerOnly) method you can see java doc says that: Throws: SecurityException - If a security manager exists and its SecurityManager.checkWrite(java.lang.String) method denies write access to the file...

How can I use JavaDocs in Eclipse to show conditional return statements?

javadoc
I have a simple method "ValidateUser" that returns a different string depending on whether or not the user has successfully logged in. Right now I've just documented the first possible output. /** * *@param user the username of the user *@param password the password of the user *@return True <br>...

Javadoc link tag with List parameter

java,javadoc
I was writing a javadoc link tag, with the parameter List as something like this. {@link #getVersionMetadata(String, String, String, List<String>) It does not feel right to me. And escaping the < and > does not seem acceptable by the IDE. {@link #getVersionMetadata(String, String, String, List&lt;String&gt;) What is the correct way...

JavaBean documentation

java,javabeans,javadoc
I've been messing with making custom controls in Java, and I'm wondering what the proper way to add documentation is. I've got lots of private variables with getters and setters, and each variable has it's own PROP_[variable name] variable. I'm specifically looking for the way to document them that would...