DO NOT REPLY [Bug 13960] New: - Incompatible Javadoc Comments in EmbededServletOptions.java

[bu...@apache.org]

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=13960>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=13960

Incompatible Javadoc Comments in EmbededServletOptions.java

           Summary: Incompatible Javadoc Comments in
                    EmbededServletOptions.java
           Product: Tomcat 4
           Version: Nightly Build
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: Minor
          Priority: Other
         Component: Jasper
        AssignedTo: tomcat-dev@jakarta.apache.org
        ReportedBy: medined@mtolive.com


While compiling Tomcat v4.1.12, I received serveral Javadoc errors in 
org/apache/jasper/EmbededServletOptions.java. I updated several comments to
avoid using the question mark punctuation which javadoc doesn't like. I don't 
have the cvs diff program, so I'm simply including the updated comments and 
their associated class elements.

In org/apache/jasper/EmbededServletOptions.java - Please change the comments
for the following variables so the first sentence is found correctly.

    /**
     * Toggles support for "large" files. What this essentially
     * means is that we generated code so that the HTML data in a JSP
     * file is stored separately as opposed to those constant string
     * data being used literally in the generated servlet. 
     */
    public boolean largeFile = false;


    /**
     * Toggles support for "mapped" files. This will generate
     * servlet that has a print statement per line of the JSP file.
     * This seems like a really nice feature to have for debugging.
     */
    public boolean mappedFile = false;

    /**
     * Toggles stack traces and such displayed in the client's
     * browser. If this is false, such messages go to the standard
     * error or a log file if the standard error is redirected. 
     */
    public boolean sendErrorToClient = false;

    /**
     * Toggles including debugging information in the class file.
     */
    public boolean classDebugInfo = true;

    /**
     * Toggles the JSP reloading check.
     */
    public boolean reloading = true;

    /**
     * Specifies the directory for the generated servlets.
     */
    public File scratchDir;

    /**
     * Specifies the classpath to use while compiling generated servlets.
     */
    public String classpath = null;

    /**
     * Getter method to see if generated code is being kept.
     */
    public boolean getKeepGenerated() {
        return keepGenerated;
    }

    /**
     * Getter method to see if we supporting large files.
     */
    public boolean getLargeFile() {
        return largeFile;
    }

    /**
     * Getter method to determine if we supporting HTML mapped servlets.
     */
    public boolean getMappedFile() {
        return mappedFile;
    }

    /**
     * Getter method to determine if errors should be sent to client or thrown 
into stderr.
     */
    public boolean getSendErrorToClient() {
        return sendErrorToClient;
    }

    /**
     * Getter method to determine if class filesshould be compiled with debug 
information.
     */
    public boolean getClassDebugInfo() {
        return classDebugInfo;
    }

    /**
     * Getter method to determine if Jasper is being used in development mode?
     */
    public boolean getDevelopment() {
        return development;
    }

    /**
     * Getter method to determine JSP reloading.
     */
    public boolean getReloading() {
        return reloading;
    }

    /**
     * Getter method to determine the scratch dir.
     */

    /**
     * Getter method to determine the classpath used while compiling the 
servlets
     * generated from JSP files.
     */
    public String getClassPath() {
        return classpath;
    }

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>