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

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Studio.ClassDocumentation.ICommentBuilder

File:CommentBuilder
Purpose:Parse a longchar and build a formated HTML string.
Author(s):Sebastian Duengel / Consultingwerk Ltd.
Created:Mon Apr 29 09:18:13 CEST 2013
Notes:Define in a seperate class, then you can define your own
comment style for the HTML Documentation tool.

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
LONGCHAR CommentFormater (longchar) Build a HTML Output for the comment from the commentparser comment.
FillDetailParameterTempTable (longchar, table) Create a parameter temp-table for the parameter detail output.
LONGCHAR GetUnitPurpose (longchar) Get the purpose comment form the unit
LONGCHAR ParseComment (longchar) Parse the full comment block.
RemoveOedtStars (longchar) Removes the OEDT Style characters from the left
LONGCHAR SummaryComment (longchar) Create a formated comment for the summary
LONGCHAR UnitCommentFormater (longchar) Create a formated unit comment from the commentparser comment.


Method Detail
Top

LONGCHAR CommentFormater (longchar)
Purpose: Build a HTML Output for the comment from the commentparser comment.
Notes:

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

FillDetailParameterTempTable (longchar, table)
Purpose: Create a parameter temp-table for the parameter detail output.
Notes: The template DocumentDetailsParameter style the parameter output

Parameters:
pcComment LONGCHAR
A longchar value which is formated from the comment block.
eParameterComment TEMP-TABLE eParameterComment
The temp-table for the comments.
Top

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

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

LONGCHAR ParseComment (longchar)
Purpose: Parse the full comment block.
Notes:

Parameters:
pcComment LONGCHAR
A longchar value which formated from the comment block.
Returns LONGCHAR
Get the comment block
Top

RemoveOedtStars (longchar)
Purpose: Removes the OEDT Style characters from the left
Notes:

Parameters:
pcLine LONGCHAR
The line to remove "* " from the left
Top

LONGCHAR SummaryComment (longchar)
Purpose: Create a formated comment for the summary
Notes:

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

LONGCHAR UnitCommentFormater (longchar)
Purpose: Create a formated unit comment from the commentparser comment.
Notes:

Parameters:
pcComment LONGCHAR
The comment string
Returns LONGCHAR
A valid HTML Longchar


Temp-Table Detail

Temp-Table eParameterComment

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       03.05.2026 21:45:32