javadoc

问题 I'm working on a small library for our in-company use, and have been heavily documenting it. Now I'm building my jar with the following code: <project name="commonutils" default="compile" basedir="."> <property name="src" location="src" /> <property name="build" location="buildDirecotry" /> <target name="compile"> <delete file="${ant.project.name}.jar" /> <mkdir dir="${build}"/> <javac srcdir="${src}" destdir="${build}" debug="on" target="1.5"> <classpath> <pathelement location="lib/build

问题 I've installed JDK 8 and Eclipse Kepler on a new PC then imported some old projects copied from an old PC (that had been using JDK 6 but that is probably not relevant). I get errors which seem inappropriate. For example in a class that implements Observer , Eclipse says my update method "must override a Superclass method." When I hover the mouse over Observer in public class Foo implements Observer { Instead of Javadoc I get java.util.Observer Note: This element neither has attached source

问题 I'm very new to Java and taking an online course with little feedback. I think I have the program completed okay, but my prof requires comments to be done and I've had no guidance on them. My biggest area seems to be the @param comments. I've tried putting different things in there but nothing is correct. Can anyone tell me what I'm doing wrong? Give me a link for easy to read info on @param comments. Here's my code: /** * */ package edu.westga.cs6311.rectangles; import java.awt.Rectangle; /*

问题 I am trying to generate my documentation for my android project with javadoc. The problem is that javadoc isn't able to find the android package. My error is the same as this one. If I am trying the first solution it says: javadoc: error - The -classpath option may be specified no more than once. What am I doing wrong? Furthermore, I tried this solution, but I dont know what I have to do at the last step. 回答1: I've found you can add multiple paths to -classpath by separating them with semi

问题 I am trying to generate my documentation for my android project with javadoc. The problem is that javadoc isn't able to find the android package. My error is the same as this one. If I am trying the first solution it says: javadoc: error - The -classpath option may be specified no more than once. What am I doing wrong? Furthermore, I tried this solution, but I dont know what I have to do at the last step. 回答1: I've found you can add multiple paths to -classpath by separating them with semi

问题 I've never run javadoc myself (whether at command-line or ant's javadoc task; I'll be using ant) -- I need to produce a javadoc for a library that I've written. The problem is that my java library is organized into several packages, and there's no way in Java to make classes public within a library but not public to the outside world, so I have a bunch of classes that are public from an implementation standpoint but not a semantic standpoint from the library's point of view. So I need to

问题 OK. There appears to be lots of information out there on how to do this but I'm not getting the information in my javadoc for the package description. Plus, I'm a little (or a lot) confused about the exact procedure on how to do this. I've created a package-info.java class as specified in this answer. /* * Package description that I want to get added to my javadoc */ package com.pdl.myapp; But when I run generate javadocs nothing appears in the description for the package in the javadocs.

问题 /** {@value Constants#KEY_MEAN} blah * {@value Constants#KEY_STDDEV} * @return A JSONObject with keys for mean and standardDeviation */ When I use this javadoc outside Constants.java but inside the same package, eclipse will just output the plain text, and when generating Javadoc, nothing gets displayed. Is this at all possible? 回答1: Best start with the obvious. The referenced fields are static as well as not private , correct? e.g., public static final KEY_MEAN = 1337; I've been working on

问题 Some API docs contain information at package level. For example java.io contains 3 package-level sections here http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html The sections are: "Package java.io Description", "Package Specification" and "Related Documentation". Where should I put these sections content in my own project so that javadoc processes it in the same way? 回答1: create a file called package-info.java in each package inside do the following /** * Javadoc */ package

问题 The exception Eclipse is raising every time I try to load javadoc (in this case, for the String class) from the Java library is pasted below. However, if I try to hover-to-load javadoc I've written myself, it works fine! This issue sort-of became a reality overnight, so I'm quite flabbergasted - one might say - as to why it is happening. Java Model Exception: Java Model Status [Unknown javadoc format for String {key=Ljava/lang/String;} [in String.class [in java.lang [in C:\Program Files (x86)