Namespace: Consultingwerk.Studio.ClassDocumentation
Interface 
ICommentBuilder Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.Studio.ClassDocumentation.CommentBuilder

File:ICommentParser
Purpose:Describes methods of a class than can return a
formated comment.
Author(s):Sebastian Düngel / Consultingwerk Ltd.
Created:Mon Apr 29 09:09:28 CEST 2013

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 temptable with the detail comments.
+ LONGCHAR GetUnitPurpose (longchar) Get the purpose comment form the unit
+ LONGCHAR ParseComment (longchar) Create a formated comment block.
+ 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

PUBLIC 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

PUBLIC FillDetailParameterTempTable (longchar, table)
Purpose: Create a temptable with the detail comments.
Notes:

Parameters:
pcComment LONGCHAR
A longchar value which formated from the comment block.
eParameterComment TEMP-TABLE eParameterComment
The Temptable for the parameters and comments
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 ParseComment (longchar)
Purpose: Create a formated comment block.
Notes:

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

PUBLIC 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

PUBLIC 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-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:22:15