Fix some more JavaDoc comments to stop javadoc from complaining.
This commit is contained in:
parent
f89a057ffb
commit
112bc0f6c1
12 changed files with 29 additions and 24 deletions
|
@ -34,7 +34,7 @@ public class DocPrototype extends DocDirElement {
|
||||||
/**
|
/**
|
||||||
* creates a prototype that is independent of an
|
* creates a prototype that is independent of an
|
||||||
* application object
|
* application object
|
||||||
* @param homedirectory
|
* @param location
|
||||||
*/
|
*/
|
||||||
public static DocPrototype newInstance(File location) {
|
public static DocPrototype newInstance(File location) {
|
||||||
return newInstance(location, null);
|
return newInstance(location, null);
|
||||||
|
@ -43,8 +43,8 @@ public class DocPrototype extends DocDirElement {
|
||||||
/**
|
/**
|
||||||
* creates a prototype that is connected to an
|
* creates a prototype that is connected to an
|
||||||
* application object and resides in app's home dir.
|
* application object and resides in app's home dir.
|
||||||
* @param application
|
* @param location
|
||||||
* @param name
|
* @param parent
|
||||||
*/
|
*/
|
||||||
public static DocPrototype newInstance(File location, DocElement parent) {
|
public static DocPrototype newInstance(File location, DocElement parent) {
|
||||||
DocPrototype pt = new DocPrototype(location.getName(), location, parent);
|
DocPrototype pt = new DocPrototype(location.getName(), location, parent);
|
||||||
|
|
|
@ -72,8 +72,8 @@ public final class DocTag {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param checks if a line is a tag
|
* @param rawTag a line from a helmadoc comment
|
||||||
* @return true/false
|
* @return true if the line represents a tag
|
||||||
*/
|
*/
|
||||||
public static boolean isTagStart(String rawTag) {
|
public static boolean isTagStart(String rawTag) {
|
||||||
if (rawTag.trim().startsWith("@"))
|
if (rawTag.trim().startsWith("@"))
|
||||||
|
@ -86,7 +86,7 @@ public final class DocTag {
|
||||||
/**
|
/**
|
||||||
* match tags where we want different names to be valid
|
* match tags where we want different names to be valid
|
||||||
* as one and the same tag
|
* as one and the same tag
|
||||||
* @param tagname original name
|
* @param tagName original name
|
||||||
* @return modified name if tag was matched
|
* @return modified name if tag was matched
|
||||||
*/
|
*/
|
||||||
public static String matchTagName(String tagName) {
|
public static String matchTagName(String tagName) {
|
||||||
|
|
|
@ -54,7 +54,7 @@ public final class Util {
|
||||||
/**
|
/**
|
||||||
* chops anything that comes after a closing comment tag
|
* chops anything that comes after a closing comment tag
|
||||||
*
|
*
|
||||||
* @param raw comment
|
* @param comment the raw comment
|
||||||
*
|
*
|
||||||
* @return chopped comment
|
* @return chopped comment
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -188,7 +188,7 @@ public class SessionBean implements Serializable {
|
||||||
* Return the message that is to be displayed upon the next
|
* Return the message that is to be displayed upon the next
|
||||||
* request within this session.
|
* request within this session.
|
||||||
*
|
*
|
||||||
* @return
|
* @return the message, or null if none was set.
|
||||||
*/
|
*/
|
||||||
public String getMessage() {
|
public String getMessage() {
|
||||||
return session.message;
|
return session.message;
|
||||||
|
|
|
@ -32,7 +32,15 @@ public abstract class ImageGenerator {
|
||||||
protected static ImageGenerator generator = null;
|
protected static ImageGenerator generator = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
* Returns an ImageGenerator singleton, creating it if necessary. If the JIMI
|
||||||
|
* package is installed, an instance of {@link helma.image.jimi.JimiGenerator JimiGenerator}
|
||||||
|
* will be returned. Otherwise, if the javax.imageio package is available,
|
||||||
|
* an instance of {@link helma.image.imageio.ImageIOGenerator ImageIOGenerator}
|
||||||
|
* is returned. Additionally, the class of the ImageGenerator implementation
|
||||||
|
* to be used can be set using the <code>imageGenerator</code> property in either
|
||||||
|
* the app.properties or server.properties file.
|
||||||
|
*
|
||||||
|
* @return a new ImageGenerator instance
|
||||||
*/
|
*/
|
||||||
public static ImageGenerator getInstance() {
|
public static ImageGenerator getInstance() {
|
||||||
if (generator == null) {
|
if (generator == null) {
|
||||||
|
@ -150,7 +158,7 @@ public abstract class ImageGenerator {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param file the filename the filename of the image to create
|
* @param filename the filename of the image to create
|
||||||
*
|
*
|
||||||
* @return the newly created image
|
* @return the newly created image
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
@ -188,7 +196,7 @@ public abstract class ImageGenerator {
|
||||||
/**
|
/**
|
||||||
* Saves the image. Image format is deduced from filename.
|
* Saves the image. Image format is deduced from filename.
|
||||||
*
|
*
|
||||||
* @param image
|
* @param wrapper
|
||||||
* @param filename
|
* @param filename
|
||||||
* @param quality
|
* @param quality
|
||||||
* @param alpha
|
* @param alpha
|
||||||
|
|
|
@ -53,11 +53,9 @@ public class ImageWrapper {
|
||||||
/**
|
/**
|
||||||
* Creates a new ImageWrapper object.
|
* Creates a new ImageWrapper object.
|
||||||
*
|
*
|
||||||
* @param img ...
|
* @param image ...
|
||||||
* @param g ...
|
|
||||||
* @param width ...
|
* @param width ...
|
||||||
* @param height ...
|
* @param height ...
|
||||||
* @param imggen ...
|
|
||||||
*/
|
*/
|
||||||
public ImageWrapper(Image image, int width, int height,
|
public ImageWrapper(Image image, int width, int height,
|
||||||
ImageGenerator generator) {
|
ImageGenerator generator) {
|
||||||
|
|
|
@ -39,7 +39,7 @@ import helma.image.*;
|
||||||
*/
|
*/
|
||||||
public class ImageIOGenerator extends ImageGenerator {
|
public class ImageIOGenerator extends ImageGenerator {
|
||||||
/**
|
/**
|
||||||
* @param file the filename the filename of the image to create
|
* @param filename the filename of the image to create
|
||||||
*
|
*
|
||||||
* @return the newly created image
|
* @return the newly created image
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
|
|
@ -35,7 +35,7 @@ public class JimiGenerator extends ImageGenerator {
|
||||||
* @param quality ...
|
* @param quality ...
|
||||||
* @param alpha ...
|
* @param alpha ...
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* @see helma.image.ImageGenerator#saveAs(helma.image.ImageWrapper, java.lang.String, float, boolean)
|
* @see helma.image.ImageGenerator#write(helma.image.ImageWrapper, java.lang.String, float, boolean)
|
||||||
*/
|
*/
|
||||||
public void write(ImageWrapper wrapper, String filename, float quality, boolean alpha) throws IOException {
|
public void write(ImageWrapper wrapper, String filename, float quality, boolean alpha) throws IOException {
|
||||||
try {
|
try {
|
||||||
|
@ -61,7 +61,7 @@ public class JimiGenerator extends ImageGenerator {
|
||||||
// the quality value does mean something here and can be specified:
|
// the quality value does mean something here and can be specified:
|
||||||
if (quality >= 0.0 && quality <= 1.0) {
|
if (quality >= 0.0 && quality <= 1.0) {
|
||||||
JPGOptions options = new JPGOptions();
|
JPGOptions options = new JPGOptions();
|
||||||
options.setQuality((int) Math.round(quality * 100));
|
options.setQuality(Math.round(quality * 100));
|
||||||
source.setOptions(options);
|
source.setOptions(options);
|
||||||
}
|
}
|
||||||
} else if (lowerCaseName.endsWith(".png")) {
|
} else if (lowerCaseName.endsWith(".png")) {
|
||||||
|
|
|
@ -35,9 +35,9 @@ import java.io.*; // needed only for main() method.
|
||||||
*
|
*
|
||||||
* @author Kevin Kelley (kelley@ruralnet.net)
|
* @author Kevin Kelley (kelley@ruralnet.net)
|
||||||
* @version 1.3
|
* @version 1.3
|
||||||
* @date 06 August 1998
|
* date 06 August 1998
|
||||||
* @modified 14 February 2000
|
* modified 14 February 2000
|
||||||
* @modified 22 September 2000
|
* modified 22 September 2000
|
||||||
*/
|
*/
|
||||||
public class Base64 {
|
public class Base64 {
|
||||||
|
|
||||||
|
|
|
@ -119,7 +119,7 @@ public class LanguageTag implements Serializable, Cloneable {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Construct a Language tag from a spec
|
* Construct a Language tag from a spec
|
||||||
* @parameter spec, A string representing a LangateTag
|
* @param spec A string representing a LangateTag
|
||||||
*/
|
*/
|
||||||
public LanguageTag(String spec) {
|
public LanguageTag(String spec) {
|
||||||
int strl = spec.length() ;
|
int strl = spec.length() ;
|
||||||
|
|
|
@ -215,7 +215,7 @@ public class MimeParser {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create an instance of the MIMEParser class.
|
* Create an instance of the MIMEParser class.
|
||||||
* @param in The input stream to be parsed as a MIME stream.
|
* @param input The input stream to be parsed as a MIME stream.
|
||||||
* @param factory The factory used to create MIME header holders.
|
* @param factory The factory used to create MIME header holders.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -262,8 +262,7 @@ public class MimeType implements Serializable, Cloneable {
|
||||||
* tries to be compliant with HTTP1.1, p 15, although it is not
|
* tries to be compliant with HTTP1.1, p 15, although it is not
|
||||||
* (because of quoted-text not being accepted).
|
* (because of quoted-text not being accepted).
|
||||||
* FIXME
|
* FIXME
|
||||||
* @parameter spec A string representing a MimeType
|
* @param spec A string representing a MimeType
|
||||||
* @return A MimeType object
|
|
||||||
* @exception MimeTypeFormatException if the string couldn't be parsed.
|
* @exception MimeTypeFormatException if the string couldn't be parsed.
|
||||||
*/
|
*/
|
||||||
public MimeType (String spec)
|
public MimeType (String spec)
|
||||||
|
|
Loading…
Add table
Reference in a new issue