com.togethersoft.openapi.ide.inspector.util
Class DocUtil

public class DocUtil

This utility class has only one method to get javadoc for the specified RwiElement.
This class is used by DocComponent to generated javadoc and show it on the "Doc" tab in the inspector.

Author:
TogetherSoft
Since: Together 4.0
See Also: DocComponent
Field Summary
 private final static String[] []attrInfo
           
 private final static String[] []clazzInfo
           
 private final static StringDeclaration_end
           
 private final static StringDeclaration_Name_end
           
 private final static StringDeclaration_Name_start
           
 private final static StringDeclaration_start
           
 private final static StringDeprecated_Description_end
           
 private final static StringDeprecated_Description_start
           
 private final static StringDeprecated_end
           
 private final static StringDeprecated_start
           
 private final static StringDescription_end
           
 private final static StringDescription_start
           
 private final static StringDocumentation_end
           
 private final static StringDocumentation_start
           
 private final static String[] []operInfo
           
 private final static String[] []otherInfo
           
 private final static StringTags_end
           
 private final static StringTags_Indent_end
           
 private final static StringTags_Indent_start
           
 private final static StringTags_Name_end
           
 private final static StringTags_Name_start
           
 private final static StringTags_NextRow_end
           
 private final static StringTags_NextRow_start
           
 private final static StringTags_Row_end
           
 private final static StringTags_Row_start
           
 private final static StringTags_start
           
 private static StringBuffertextBuf
           

Method Summary
 private static voidattributeDetail(RwiMember member)
           
 private static voidclassDetail(RwiNode node)
           
 private static voidelementDetail(RwiElement element)
           
 private static voidendHTML()
           
 private static StringgetDeprecatedDescription(RwiElement element)
           
 static StringgetDocumentation(RwiElement element)
           
 static StringgetHTMLDocument(RwiElement element)
          Return javadoc for the selected RwiElement.
 private static intindexOfWholeWord(String str, String substr, int start)
           
 private static booleanisDeprecated(RwiElement element)
           
 private static voidnoteDetail(RwiElement element)
           
 private static voidoperationDetail(RwiMember member)
           
 private static voidputColumnTags(String displayedTagName, Enumeration valueEnum)
           
 private static voidputCommaTagsOneRow(String displayedTagName, Enumeration valueEnum)
           
 private static voidputCommaTagsTwoRows(String displayedTagName, Enumeration valueEnum)
           
 private static voidputTagName(String displayedTagName)
           
 private static voidputTagNameValue(String displayedTagName, String value)
           
 private static voidputTags(RwiElement element, String[] [] tagInfo, boolean withIndent)
           
 private static voidputText(String text)
           
 private static voidputTextWithReplace(String text)
           
 private static StringremoveLinkTags(String s)
           
 private static Stringreplace(String source, String searchFor, String replaceWith)
           
 private static StringreplaceLTGTEntity(String src)
           
 private static voidstartHTML()
           

Field Detail

attrInfo

private final static String[] [] attrInfo

clazzInfo

private final static String[] [] clazzInfo

Declaration_end

private final static String Declaration_end

Declaration_Name_end

private final static String Declaration_Name_end

Declaration_Name_start

private final static String Declaration_Name_start

Declaration_start

private final static String Declaration_start

Deprecated_Description_end

private final static String Deprecated_Description_end

Deprecated_Description_start

private final static String Deprecated_Description_start

Deprecated_end

private final static String Deprecated_end

Deprecated_start

private final static String Deprecated_start

Description_end

private final static String Description_end

Description_start

private final static String Description_start

Documentation_end

private final static String Documentation_end

Documentation_start

private final static String Documentation_start

operInfo

private final static String[] [] operInfo

otherInfo

private final static String[] [] otherInfo

Tags_end

private final static String Tags_end

Tags_Indent_end

private final static String Tags_Indent_end

Tags_Indent_start

private final static String Tags_Indent_start

Tags_Name_end

private final static String Tags_Name_end

Tags_Name_start

private final static String Tags_Name_start

Tags_NextRow_end

private final static String Tags_NextRow_end

Tags_NextRow_start

private final static String Tags_NextRow_start

Tags_Row_end

private final static String Tags_Row_end

Tags_Row_start

private final static String Tags_Row_start

Tags_start

private final static String Tags_start

textBuf

private static StringBuffer textBuf
Method Detail

attributeDetail

private static void attributeDetail(RwiMember member)

classDetail

private static void classDetail(RwiNode node)

elementDetail

private static void elementDetail(RwiElement element)

endHTML

private static void endHTML()

getDeprecatedDescription

private static String getDeprecatedDescription(RwiElement element)

getDocumentation

public static String getDocumentation(RwiElement element)

getHTMLDocument

public static String getHTMLDocument(RwiElement element)
Return javadoc for the selected RwiElement.
Parameters:
element RwiElement for which javadoc will be generated
Returns: javadoc for the selected RwiElement

indexOfWholeWord

private static int indexOfWholeWord(String str, String substr, int start)

isDeprecated

private static boolean isDeprecated(RwiElement element)

noteDetail

private static void noteDetail(RwiElement element)

operationDetail

private static void operationDetail(RwiMember member)

putColumnTags

private static void putColumnTags(String displayedTagName, Enumeration valueEnum)

putCommaTagsOneRow

private static void putCommaTagsOneRow(String displayedTagName, Enumeration valueEnum)

putCommaTagsTwoRows

private static void putCommaTagsTwoRows(String displayedTagName, Enumeration valueEnum)

putTagName

private static void putTagName(String displayedTagName)

putTagNameValue

private static void putTagNameValue(String displayedTagName, String value)

putTags

private static void putTags(RwiElement element, String[] [] tagInfo, boolean withIndent)

putText

private static void putText(String text)

putTextWithReplace

private static void putTextWithReplace(String text)

removeLinkTags

private static String removeLinkTags(String s)

replace

private static String replace(String source, String searchFor, String replaceWith)

replaceLTGTEntity

private static String replaceLTGTEntity(String src)

startHTML

private static void startHTML()

Association Links

to Class java.lang.StringBuffer

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String