Namespace: Consultingwerk.Studio.ClassDocumentation
Class 
ClassDocumentationHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.ClassDocumentation.ClassDocumentationHelper

Inherits: Progress.Lang.Object

File:ClassDocumentationHelper
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu May 10 15:55:13 CEST 2012

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ LONGCHAR CommentFormater (longchar) Format the comment.
+ LONGCHAR CommentParser (longchar, table) Build the comment.
+ LONGCHAR GenerateCommentLinks (longchar) Analyse the comment of weblinks and create an link tag
+ LONGCHAR GenerateParentClassesHyperlinks (character, IDocumentWriterParameter) Generates parent hyperlinks in a html div constainer
+ LONGCHAR GenericTypesParser (character, IDocumentWriterParameter) Get the generic type reference list
+ CHARACTER GetClassReferenceHyperlink (character, character, logical, IDocumentWriterParameter) Build the Method / Property / Events reference hyperlink
+ CHARACTER GetClassReferenceHyperlink (character, logical, IDocumentWriterParameter) Get the class reference hyperlink
+ CHARACTER GetFullTypeName (character, table)
+ CHARACTER GetShortModifier (character) Return the ShortModifier
+ LONGCHAR GetSummaryComment (longchar) Returns a comment for the summary overview.
+ LONGCHAR GetUnitPurpose (longchar) Get the purpose comment form the unit
+ LONGCHAR ReplaceSpecialCharacters (longchar) Removes all special characters by replacing them with proper XML markup
+ CHARACTER ShortSignatureParser (character, character) Parse a longchar and replace values.
+ CHARACTER SignatureParser (character, character, character, character, logical, logical, IDocumentWriterParameter) Parse a longchar and replace values.
+ LONGCHAR UnitCommentFormater (longchar) Format the Unit comment.

Top Constructor Summary
Options Name Purpose
ClassDocumentationHelper () Static constructor for the ClassDocumentationHelper class
- ClassDocumentationHelper () Private constructor for the ClassDocumentationHelper class


Method Detail
Top

PUBLIC LONGCHAR CommentFormater (longchar)
Purpose: Format the comment.
Notes:

Parameters:
pcComment LONGCHAR
A longchar value which formated from the GetFormateComment.
Returns LONGCHAR
The formated longchar value
Top

PUBLIC LONGCHAR CommentParser (longchar, table)
Purpose: Build the comment.
Notes:

Parameters:
pcComment LONGCHAR
A longchar value which formated from the commentparser.
eParameterComment TABLE
The Temptable with the generated Input and return paramters.
Returns LONGCHAR
The formated longchar value
Top

PUBLIC LONGCHAR GenerateCommentLinks (longchar)
Purpose: Analyse the comment of weblinks and create an link tag
Notes:

Parameters:
pcComment LONGCHAR
The comment string
Returns LONGCHAR
A Longchar
Top

PUBLIC LONGCHAR GenerateParentClassesHyperlinks (character, IDocumentWriterParameter)
Purpose: Generates parent hyperlinks in a html div constainer
Notes:

Parameters:
plcClasses CHARACTER
The comma seperate parent class list
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The paramter object
Returns LONGCHAR
A LONGCHAR with a formated ClassesHyperlinks
Top

PUBLIC LONGCHAR GenericTypesParser (character, IDocumentWriterParameter)
Purpose: Get the generic type reference list
Notes:

Parameters:
pcReturnType CHARACTER
THE CHARACTER value set the ReturnTyp in the signature
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object
Returns LONGCHAR
a generic type html reference list
Top

PUBLIC CHARACTER GetClassReferenceHyperlink (character, character, logical, IDocumentWriterParameter)
Purpose: Build the Method / Property / Events reference hyperlink
Notes:

Parameters:
cClass CHARACTER
The fulltypename from the reference
cMethod CHARACTER
The Method / Property / Events signature or name
lWithLink LOGICAL
returns the returnvalue with or without link
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object
Returns CHARACTER
A valid HTML a tag
Top

PUBLIC CHARACTER GetClassReferenceHyperlink (character, logical, IDocumentWriterParameter)
Purpose: Get the class reference hyperlink
Notes:

Parameters:
cClass CHARACTER
The fulltypename from the reference
lWithLink LOGICAL
returns the returnvalue with or without link
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object
Returns CHARACTER
A valid HTML a tag
Top

PUBLIC CHARACTER GetFullTypeName (character, table)
Purpose:
Notes:

Parameters:
pcTypeName CHARACTER
The type name to be located
eUsing TABLE
TABLE The ttUsing containing the USING Statements of the current compile unit
Returns CHARACTER
The full type name
Top

PUBLIC CHARACTER GetShortModifier (character)
Purpose: Return the ShortModifier
Notes:

Parameters:
pcLongModifiere CHARACTER
The modifier longname
Returns CHARACTER
A shortmodifier
Top

PUBLIC LONGCHAR GetSummaryComment (longchar)
Purpose: Returns a comment for the summary overview.
Notes:

Parameters:
plcComment LONGCHAR
Comment String
Returns LONGCHAR
Get the display summary comment
Top

PUBLIC LONGCHAR GetUnitPurpose (longchar)
Purpose: Get the purpose comment form the unit
Notes:

Parameters:
pcComment LONGCHAR
A longcharvalue with the purpose comment.
Returns LONGCHAR
A longchar value
Top

PUBLIC LONGCHAR ReplaceSpecialCharacters (longchar)
Purpose: Removes all special characters by replacing them with proper XML markup
Notes:

Parameters:
plcString LONGCHAR
A longchar value in which to remove/replaced special characters
Returns LONGCHAR
The longchar without the removed/replaced special characters
Top

PUBLIC CHARACTER ShortSignatureParser (character, character)
Purpose: Parse a longchar and replace values.
Notes:

Parameters:
pcSignature CHARACTER
The CHARCATER value which do you want to parse.
pcReturnType CHARACTER
THE CHARACTER value set the ReturnTyp in the signature
Returns CHARACTER
Return the manipulated signature
Top

PUBLIC CHARACTER SignatureParser (character, character, character, character, logical, logical, IDocumentWriterParameter)
Purpose: Parse a longchar and replace values.
Notes:

Parameters:
pcSignature CHARACTER
The CHARACTER value which do you want to parse.
pcModifier CHARACTER
The CHARACTER value set the modifiere in the signature
pcReturnType CHARACTER
The CHARACTER value set the ReturnTyp in the signature
pcDelegateType CHARACTER
The CHARACTER value set the DelegateType
plWithLink LOGICAL
generated the the signature with an Anchor Link
plWithReturnLink LOGICAL
generate the signature with or without return type link
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object
Returns CHARACTER
Return the manipulated signature
Top

PUBLIC LONGCHAR UnitCommentFormater (longchar)
Purpose: Format the Unit comment.
Notes:

Parameters:
pcComment LONGCHAR
A longchar value which formated from the GetFormateComment.
Returns LONGCHAR
The formated longchar value


Constructor Detail
Top

STATIC ClassDocumentationHelper ()
Purpose: Static constructor for the ClassDocumentationHelper class
Notes:

Top

PRIVATE ClassDocumentationHelper ()
Purpose: Private constructor for the ClassDocumentationHelper class
Notes: Disallow instance creation



©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:45:03