Handling of formatter modules through file extensions
About infos
All these general settings affect every formatter module of Jindent.
title
5.3.1 Messages & Warnings
While Jindent's formatting process different kind of events can happen. Users can be informed about these
events by messages, warnings and errors:
Messages just contain simple informations.
Warnings are thrown if something 'harmless' went wrong, but Jindent is still able to continue its formatting.
For instance: Jindent was not able to wrap a line within specified maximal line length or it detected an incomplete
JavaDoc comment.
Errors are thrown if something 'serious' happend and Jindent was not able to continue its formatting process.
For instance: if the grammar of a source file is incomplete.
After formatting Jindent shows all selected types of messages, warnings and errors in a special report window.
Messages are reported in black, warnings in yellow and errors in red.
Example: Message report of Jindent's JDeveloper integration
Double click on the message, warning or error item and (depending on the Jindent integration) an editor window will
open up which cursor is located at the corresponding line and column position.
title
5.3.1.1 Report Of Messages & Warnings
Parser messages
Enables report of parser events.
Parser events are currently not reported. This setting is a place holder for future purposes.
Formatter messages
Enables report of formatter events.
Formatter messages are:
Created Jindent commercial note
Created convention note
Created header
Created footer
Inserted ( ... ) for ...
Inserted { ... } for ...
Detected previous header. Deleted from top.
Detected previous footer. Deleted from bottom.
Deleted ... comment
Formatter warnings are:
Was not able to wrap line at column ...
Deleted ... comment
JavaDoc messages
Enables report of JavaDoc events.
JavaDoc messages are:
Inserted missing @param ... tag
Inserted missing @return tag
Inserted missing @throws ... tag
Deleted obsolete JavaDoc tag ...
Deleted JavaDoc comment
Created JavaDoc comment for ...
JavaDoc warnings are:
Missing @param ... tag
Missing @return tag
Missing @throws ... tag
@tag ... is obsolete
Report every file access
Enables verbose reporting of every file access.
If this features is enabled then Jindent shows every read/write/copy file access in its report window.
Even the files which did not create an explicit message, warning or error.
Log file
Enables logging of all Jindent file accesses, messages, warnings and errors to a specified log file.