Class FormatDescription

java.lang.Object
  FormatDescription

public class FormatDescription
extends java.lang.Object

FormatDescription.java July 30, 2003 FormatDescription is a program that returns a description indented and wrapped. It has an option to start the description at the equals, but the default is not to. It trims all spaces indents and wraps the description.
Mandatory parameters are:

                PARAMETER               [character string] The parameter name you want to return.
                DESCRIPTION             [character string] The description to be formatted.

        Optional parameters are:
                INDENT                  [integer] The number of spaces to add to the beginning 
                                                of each line.
                LENGTH              [integer] The number that tells the program the maximum 
                                                number of bytes each string should be.
                START_AT_EQUALS [integer] This is the location of the equals sign in the label
                                                template file. This will start the description at the 
                                                equals sign and wrap the first string appropriately if
                                                this value is not 0.
                                                Usage of this variable is START_AT_EQUALS=$equalsAt.
             

default values:

                INDENT                  = 0
                LENGTH                  = 78
                START_AT_EQUALS = 0
              

Since:

1.0

Constructor Summary

FormatDescription()

Method Summary

static void

main(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatDescription

public FormatDescription()

Method Detail

main

public static void main(java.lang.String[] args)