org.dmd.dms.doc.web

Class Converter

java.lang.Object

org.dmd.dms.doc.web.Converter

public class Converter
extends Object

The Wiki utility class provides some useful translation functionality for alterring descriptions to conform to the Google Code Wiki format. In particular, the following transformations are performed:

• pre format tags are translated to {{{ }}}
• code tags are replaced with back quotes ` `

When generating Wiki documentation, set the wiki flag to true, otherwise we leave the tags intact for HTML

Constructor Summary

Constructors

Constructor and Description
Converter()

Method Summary

Modifier and Type	Method and Description
static String	convert(Iterator<String> descriptionWithNewlines)
static String	convert(String in) Depending on the setting of the WIKI flag flag, we replace preformat and code tags with the wiki conventions.
static void	wiki(boolean f)

Methods inherited from class java.lang.Object

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

Constructor Detail

Converter

public Converter()

Method Detail

convert

public static String convert(String in)

Depending on the setting of the WIKI flag flag, we replace preformat and code tags with the wiki conventions.

Parameters:

in -

Returns:

the string converted for use in either HTML or WIKI.

wiki

public static void wiki(boolean f)

convert

public static String convert(Iterator<String> descriptionWithNewlines)