Namespace: Consultingwerk.Studio.SmartDox
Class 
ParameterCommentValidator Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.SmartDox.ParameterCommentValidator

Inherits: Progress.Lang.Object

File:ParameterCommentValidator
Purpose:Validates missing parameter comments in class files
Author(s):Sebastian Düngel / Consultingwerk Ltd.
Created:Wed Feb 06 09:18:55 CET 2013

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



Top Method Summary
Options Name Purpose
# AddTempTableRow (character, character, character, character, character, character, logical, character) Create a temptable row
+ CommentValidatorStart (IParameterCommentValidatorParameter) Start the parameter validation
# CreateMissingConstructorParameter (character, character) Create all missing constructor parameter
# CreateMissingEventParameter (character, character) Create all missing event parameter
# CreateMissingMethodParameter (character, character) Create all missing method parameter
+ ExportToFile (character) Write the TempTable to the xml file
+ GetResult (table) Returns the Temp-Table with the results of the validator
# LogMissingParameter (longchar, character, character, character, character, character, character) Log all comment lines without parameters
# LogMissingParameterComment (longchar, character, character, character, character, character, character) Log all parameters without descriptions
# LogMissingReturns (longchar, character, character, character, character, character, character) Log all missing returns comments
# RemoveOedtStars (longchar) Removes the OEDT Style characters from the left

Top Property Summary
Options Name Purpose
+ LOGICAL Verbose


Method Detail
Top

PROTECTED AddTempTableRow (character, character, character, character, character, character, logical, character)
Purpose: Create a temptable row
Notes:

Parameters:
pcParameterScope CHARACTER
The parameter scope
pcSourceType CHARACTER
The source type
pcSourceName CHARACTER
The source name (fulltypename from class)
pcMethodName CHARACTER
The method name
pcMethodModifier CHARACTER
The method modifiere
pcParameterName CHARACTER
The parameter name
plMissingComment LOGICAL
Is the comment missing in the comment of is the parameter commented but missing in code
pcParameterComment CHARACTER
is only a comment available without parameter
Top

PUBLIC CommentValidatorStart (IParameterCommentValidatorParameter)
Purpose: Start the parameter validation
Notes: This method is invoked by the start procedure
Consultingwerk/Studio/SmartDox/generate-parameter-reference.p

Parameters:
poParameter Consultingwerk.Studio.SmartDox.IParameterCommentValidatorParameter
A Consultingwerk.Studio.SmartDox.IParameterCommentValidatorParameter parameter object
Top

PROTECTED CreateMissingConstructorParameter (character, character)
Purpose: Create all missing constructor parameter
Notes:

Parameters:
pcSourceType CHARACTER
The eUnit Source type
pcSourceName CHARACTER
The eUnit source name
Top

PROTECTED CreateMissingEventParameter (character, character)
Purpose: Create all missing event parameter
Notes:

Parameters:
pcSourceType CHARACTER
The eUnit Source type
pcSourceName CHARACTER
The eUnit source name
Top

PROTECTED CreateMissingMethodParameter (character, character)
Purpose: Create all missing method parameter
Notes:

Parameters:
pcSourceType CHARACTER
The eUnit Source type
pcSourceName CHARACTER
The eUnit source name
Top

PUBLIC ExportToFile (character)
Purpose: Write the TempTable to the xml file
Notes:

Parameters:
pcTargetFile CHARACTER
set the output into targetfile
Top

PUBLIC GetResult (table)
Purpose: Returns the Temp-Table with the results of the validator
Notes:

Parameters:
ttMissingParameter TEMP-TABLE ttMissingParameter
OUTPUT TABLE The Temp-Table with the results of the validator
Top

PROTECTED LogMissingParameter (longchar, character, character, character, character, character, character)
Purpose: Log all comment lines without parameters
Notes:

Parameters:
plcComment LONGCHAR
the comment value
pcParameterScope CHARACTER
the method scope
pcSourceType CHARACTER
the source type (fulltypename)
pcSourceName CHARACTER
the source name
pcMethodName CHARACTER
the name from th emethod
pcMethodModifier CHARACTER
the modiefiere from the method
pcGUID CHARACTER
the parent GUID
Top

PROTECTED LogMissingParameterComment (longchar, character, character, character, character, character, character)
Purpose: Log all parameters without descriptions
Notes:

Parameters:
plcComment LONGCHAR
the comment value
pcParameterScope CHARACTER
the method scope
pcSourceType CHARACTER
the source type (fulltypename)
pcSourceName CHARACTER
the source name
pcMethodName CHARACTER
the name from th emethod
pcMethodModifier CHARACTER
the modiefiere from the method
pcGUID CHARACTER
the parent GUID
Top

PROTECTED LogMissingReturns (longchar, character, character, character, character, character, character)
Purpose: Log all missing returns comments
Notes:

Parameters:
plcComment LONGCHAR
the comment value
pcParameterScope CHARACTER
the method scope
pcSourceType CHARACTER
the source type (fulltypename)
pcSourceName CHARACTER
the source name
pcMethodName CHARACTER
the name from th emethod
pcMethodModifier CHARACTER
the modiefiere from the method
pcReturnType CHARACTER
the returntype from th emethod
Top

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

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


Property Detail
Top

PUBLIC LOGICAL Verbose

Returns LOGICAL


Temp-Table Detail

Temp-Table ttMissingParameter

Defined in:


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2024 19:02:54