org.opengis.tools.console
Class JDiffPostProcessing

Show UML class diagram

Object
  JDiffPostProcessing

public class JDiffPostProcessing
extends Object

Removes the javadoc tags from the XMl files generated by JDiff. The purpose of this changes is to be less distracted by formatting changes, so reader can focus more on content changes.

The very naive algorithm implemented in this class just search for <![CDATA[...]]> sections, then applies the following modifications to their content:

• When a line starting with the '@' character is found - as in @author, @see, etc. -, discard that lines and all remaining lines (because tags may span many lines).
• Remove {@link}, {@code} and other inline tags (but keep their content), in order to not be distracted by URL or font changes.
• Remove <blockquote>, <font> and a few other selected HTML elements (but keep their content), in order to not be distracted by formatting changes.
• Collapse all whitespaces to a single space character, in order to not be distracted by space changes.
• Put all the javadoc text on a single line. This is needed in order to prevent JDiff to see documentation changes when there is only line feed changes.
• Remove all <pre> HTML elements and their content, because their formatting is list as a result of the above operations anyway.

This patch is very ugly. It has been created only because I was too lazy for modifying directly JDiff code.

Method Summary

static void

main(String[] args) Removes the javadoc tags from the given XML files.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

main

public static void main(String[] args)
                 throws IOException

Removes the javadoc tags from the given XML files.

Parameters:

args - The XML files to process.

Throws:

IOException - If an error occurred while reading or writing a file.