Jindent - Java Source Code Formatter http://www.jindent.com
 

previous topic  Previous:  JavaDocs Next:  Sorting   next topic

title
5.6.1.12.2 Misc

Format existing JavaDocs

Format existing JavaDocs

Enables formatting of JavaDoc comments.

To preserve JavaDoc comment style from original source code just disable this setting.


Do not format JavaDoc comments (preserve original JavaDocs formatting from input source code) and an example could look like:

/**                                     
   Calculates something.                
                                        
   @param i   value i                   
 */                                     
public void test(int i)                 
{                                       
    ...                                 
}                                       


Format JavaDoc comments and the same example looks like:

/**                                     
 * Calculates something.                
 *                                      
 * @param i   value i                   
 */                                     
public void test(int i)                 
{                                       
    ...                                 
}                                       



Delete existing JavaDocs

Delete existing JavaDocs

Removes all JavaDoc comments.

To keep all JavaDoc comments from original source code just disable this setting.


Original input source code example:

public class MyClass {                  
                                        
    /**                                 
     * Calculates something.            
     *                                  
     * @param i   value i               
     */                                 
    public void test(int i)             
    {                                   
        ...                             
    }                                   
}                                       


After deleting JavaDoc comments:

public class MyClass {                  
                                        
    public void test(int i)             
    {                                   
        ...                             
    }                                   
}                                       

Please note: If deletion of JavaDocs and JavaDoc template insertion is enabled, then Jindent removes all JavaDocs from input source files and then inserts the new templates.



Do not create JavaDocs when @Override annotation is set

Do not create JavaDocs when @Override annotation is set

If this setting is enabled then no JavaDocs will be inserted for declarations containing a @Override annotation.



public class MyClass {                  
                                        
    @Override                           
    public void test(int i)             
    {                                   
        ...                             
    }                                   
}