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

Inherits: Progress.Lang.Object
USE-WIDGET-POOL

File:DocumentationWriter
Purpose:Generate a html documentation from xml-files.
Author(s):Sebastian Düngel / Consultingwerk Ltd.
Created:Wed Oct 10 17:11:42 CEST 2012

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



Top Method Summary
Options Name Purpose
+ AddBaseClassCommentToClass (character, handle, character, IDocumentWriterParameter) Added the base class comments
+ LONGCHAR BuildChildClasses (character, IDocumentWriterParameter) Create a html table for all ChildClasses
+ LONGCHAR BuildImplementingClasses (character, IDocumentWriterParameter) Create a html table for all implementing classes
# CopyResources (IDocumentWriterParameter) Copies the resource files to html output directory.
# CreateDocumentList (IDocumentWriterParameter, longchar) Create a html file for the link overview.
+ EnrichDocumentationFromBaseClass (character, character, IDocumentWriterParameter) Start the baseclass enrichment
# LONGCHAR GenerateConstructorDetails (longchar, IDocumentWriterParameter) Generates the methods details into a html table.
# LONGCHAR GenerateConstructorOverview (longchar, IDocumentWriterParameter) Generates the constructor names into a html table.
# LONGCHAR GenerateDatasetDetails (longchar, IDocumentWriterParameter) Generates the ProDataset details into a html table.
+ GenerateDocumentation (IDocumentWriterParameter) Start method to generate the documentation
# LONGCHAR GenerateDocumentHeader (longchar, IDocumentWriterParameter) Generates the document header
# LONGCHAR GenerateDocumentList (character, character, IDocumentWriterParameter) Generate the document list
# LONGCHAR GenerateEnumMemberOverview (longchar, IDocumentWriterParameter) Generates the enum member names into a html table.
# LONGCHAR GenerateEventDetails (longchar, IDocumentWriterParameter) Generates the events details into a html table.
# LONGCHAR GenerateEventOverview (longchar, IDocumentWriterParameter) Generates the event names into a html table.
# GenerateIndexFile (IDocumentWriterParameter) Generates the index file
# LONGCHAR GenerateInterfaceOverview (longchar, IDocumentWriterParameter) Generates the interface names into a html table.
# LONGCHAR GenerateMethodDetails (longchar, IDocumentWriterParameter) Generates the methods details into a html table.
# LONGCHAR GenerateMethodOverview (longchar, IDocumentWriterParameter) Generates the method names into a html table.
+ GeneratePackageFiles (IDocumentWriterParameter) Generates the package files @param poParameter The parameter object contains the targetdir parameter.
+ CHARACTER GeneratePackageLinks (character, IDocumentWriterParameter) Generates the package Links for the tree
# LONGCHAR GeneratePropertyDetails (longchar, IDocumentWriterParameter) Generates the properties details into a html table.
# LONGCHAR GeneratePropertyOverview (longchar, IDocumentWriterParameter) Generates the property names into a html table.
# LONGCHAR GenerateTempTableDetails (longchar, IDocumentWriterParameter) Generates the temp-table details into a html table.
+ GenerateTreeNodeTempTable (character, logical, logical, character, IDocumentWriterParameter) Generate the Nodes Temp-Table for a tree view
# LONGCHAR GenerateTreeviewOverview () Start the generating Treeview
# LONGCHAR GenerateTreeviewOverviewNodes (character, character, longchar) Generate the treeview overview nodes
+ LONGCHAR GetBodyFromPackage (longchar) Gets the content of the body of a package.html file
+ CHARACTER GetFullTypeName (character) Returns the fully qualified type name from a type name
# LONGCHAR ReplaceEnumPlaceholder (character, longchar, character, IDocumentWriterParameter) Replaces the Placeholders in a LONGCHAR value
# LONGCHAR ReplacePlaceholder (character, longchar, character, character, logical, character, logical, logical, character, character, character, character, character, character, IDocumentWriterParameter) Replaces the Placeholders in a LONGCHAR value
+ WriteMessage (character) Writes a message either to stdout (BATCH) or LOG-MANAGER


Method Detail
Top

PUBLIC AddBaseClassCommentToClass (character, handle, character, IDocumentWriterParameter)
Purpose: Added the base class comments
Notes:

Parameters:
TableName CHARACTER
the table name from the class documentation ds
hDsBaseClass HANDLE
The base class dataset
pcClassName CHARACTER
The caller classname
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The global parameter object
Top

PUBLIC LONGCHAR BuildChildClasses (character, IDocumentWriterParameter)
Purpose: Create a html table for all ChildClasses
Notes:

Parameters:
pcFullClassName CHARACTER
The full classname which inherited in the classes.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the classes.
Top

PUBLIC LONGCHAR BuildImplementingClasses (character, IDocumentWriterParameter)
Purpose: Create a html table for all implementing classes
Notes:

Parameters:
pcFullClassName CHARACTER
The full classname which implemented in the classes.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the classes.
Top

PROTECTED CopyResources (IDocumentWriterParameter)
Purpose: Copies the resource files to html output directory.
Notes:

Parameters:
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
With the parameter object.
Top

PROTECTED CreateDocumentList (IDocumentWriterParameter, longchar)
Purpose: Create a html file for the link overview.
Notes:

Parameters:
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object contains the targetdir parameter.
lcDocumentListContent LONGCHAR
The value contains the Links which generated into the html file.
Top

PUBLIC EnrichDocumentationFromBaseClass (character, character, IDocumentWriterParameter)
Purpose: Start the baseclass enrichment
Notes:

Parameters:
pcFilename CHARACTER
The xml xml-classname
pcBaseClass CHARACTER
the bace class name
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
the global parameter object
Top

PROTECTED LONGCHAR GenerateConstructorDetails (longchar, IDocumentWriterParameter)
Purpose: Generates the methods details into a html table.
Notes: It's a view how you can see all parameters and descriptions from a Method.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GenerateConstructorOverview (longchar, IDocumentWriterParameter)
Purpose: Generates the constructor names into a html table.
Notes: It's a overview of all constructors in the class.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GenerateDatasetDetails (longchar, IDocumentWriterParameter)
Purpose: Generates the ProDataset details into a html table.
Notes:

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PUBLIC GenerateDocumentation (IDocumentWriterParameter)
Purpose: Start method to generate the documentation
Notes: This method is invoked by the start procedure
Consultingwerk/Studio/ClassDocumentation/generate-class-reference.p

Parameters:
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object control the output.
Top

PROTECTED LONGCHAR GenerateDocumentHeader (longchar, IDocumentWriterParameter)
Purpose: Generates the document header
Notes:

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GenerateDocumentList (character, character, IDocumentWriterParameter)
Purpose: Generate the document list
Notes: The List is a overview of all classes.

Parameters:
pcClass CHARACTER
A CHRACTER value which show a link caption.
pcHref CHARACTER
A CHARCTER link value to the html class reference
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object.
Returns LONGCHAR
Return the generated html LONGCHAR
Top

PROTECTED LONGCHAR GenerateEnumMemberOverview (longchar, IDocumentWriterParameter)
Purpose: Generates the enum member names into a html table.
Notes: It's an overview of all properties in the class.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GenerateEventDetails (longchar, IDocumentWriterParameter)
Purpose: Generates the events details into a html table.
Notes: It's a view how you can see all parameters and descriptions from an event.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GenerateEventOverview (longchar, IDocumentWriterParameter)
Purpose: Generates the event names into a html table.
Notes: It's a overview of all events in the class.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED GenerateIndexFile (IDocumentWriterParameter)
Purpose: Generates the index file
Notes:

Parameters:
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Top

PROTECTED LONGCHAR GenerateInterfaceOverview (longchar, IDocumentWriterParameter)
Purpose: Generates the interface names into a html table.
Notes: It's a overview of all interfaces in the class.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GenerateMethodDetails (longchar, IDocumentWriterParameter)
Purpose: Generates the methods details into a html table.
Notes: It's a view how you can see all parameters and descriptions from a Method.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GenerateMethodOverview (longchar, IDocumentWriterParameter)
Purpose: Generates the method names into a html table.
Notes: It's a overview of all methods in the class.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PUBLIC GeneratePackageFiles (IDocumentWriterParameter)
Purpose: Generates the package files
Notes:

Parameters:
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object contains the targetdir parameter.
Top

PUBLIC CHARACTER GeneratePackageLinks (character, IDocumentWriterParameter)
Purpose: Generates the package Links for the tree
Notes:

Parameters:
pcFileName CHARACTER
The source file for the package link
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object.
Returns CHARACTER
The generated package link
Top

PROTECTED LONGCHAR GeneratePropertyDetails (longchar, IDocumentWriterParameter)
Purpose: Generates the properties details into a html table.
Notes: It's a view how you can see all parameters and descriptions from a properties.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GeneratePropertyOverview (longchar, IDocumentWriterParameter)
Purpose: Generates the property names into a html table.
Notes: It's a overview of all properties in the class.

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter.
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PROTECTED LONGCHAR GenerateTempTableDetails (longchar, IDocumentWriterParameter)
Purpose: Generates the temp-table details into a html table.
Notes:

Parameters:
plcDocumentTemplate LONGCHAR
A LONGCHAR, that contains the content which manipulate to do
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
poParameter The parameter object contains the targetdir parameter
Returns LONGCHAR
A LONGCHAR containes the manipulated content.
Top

PUBLIC GenerateTreeNodeTempTable (character, logical, logical, character, IDocumentWriterParameter)
Purpose: Generate the Nodes Temp-Table for a tree view
Notes:

Parameters:
pcClassName CHARACTER
The class name.
plIsInterface LOGICAL
Is the class an Interface
plIsEnum LOGICAL
Is the class an Enum
pcPackagename CHARACTER
The class package name.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object.
Top

PROTECTED LONGCHAR GenerateTreeviewOverview ()
Purpose: Start the generating Treeview
Notes: Get Treeview list of all classes.

Returns LONGCHAR
get the generated Treeview.
Top

PROTECTED LONGCHAR GenerateTreeviewOverviewNodes (character, character, longchar)
Purpose: Generate the treeview overview nodes
Notes: A recursive function to generate the treeview nodes

Parameters:
NodeName CHARACTER
The gerated Nodename.
NodeParent CHARACTER
The parent node name from the node
lcResult LONGCHAR
The generated recursive result
Returns LONGCHAR
the generated result.
Top

PUBLIC LONGCHAR GetBodyFromPackage (longchar)
Purpose: Gets the content of the body of a package.html file
Notes:

Parameters:
lcPackageContent LONGCHAR
The the package content.
Returns LONGCHAR
The content of the body of a package.html file
Top

PUBLIC CHARACTER GetFullTypeName (character)
Purpose: Returns the fully qualified type name from a type name
Notes:

Parameters:
pcTypeName CHARACTER
The typename value.
Returns CHARACTER
A LONGCHAR, return the fulltypename
Top

PROTECTED LONGCHAR ReplaceEnumPlaceholder (character, longchar, character, IDocumentWriterParameter)
Purpose: Replaces the Placeholders in a LONGCHAR value
Notes:

Parameters:
pcName CHARACTER
The CHARACTER value replace the keyword "@NAME@"
plcComment LONGCHAR
The LONGCHAR value replace the keyword "@COMMENT@"
pcTemplateName CHARACTER
The template name which be loaded and manipulated.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object.
Returns LONGCHAR
Return the manipulated template
Top

PROTECTED LONGCHAR ReplacePlaceholder (character, longchar, character, character, logical, character, logical, logical, character, character, character, character, character, character, IDocumentWriterParameter)
Purpose: Replaces the Placeholders in a LONGCHAR value
Notes:

Parameters:
pcName CHARACTER
The CHARACTER value replace the keyword "@NAME@"
plcComment LONGCHAR
The LONGCHAR value replace the keyword "@COMMENT@"
pcSignature CHARACTER
The LONGCHAR value replace the keyword "@SIGNATURE@"
pcModifier CHARACTER
The CHARACTER value replace the keyword "@MODIFIER@"
plIsStatic LOGICAL
The LOGICAL value replace the keyword "@ISSTATIC@"
pcDataType CHARACTER
The CHARACTER value replace the keyword "@DATATYPE@"
plIsAbstract LOGICAL
The LOGICAL value replace the keyword "@ISABSTRACT@"
plIsFinal LOGICAL
The LOGICAL value replace the keyword "@ISFINAL@"
pcDelegateName CHARACTER
The CHARACTER value replace the keyword "@DELEGATENAME@"
pcSetModifier CHARACTER
The CHARACTER value replace the keyword "@SETMODIFIER@"
pcGetModifier CHARACTER
The CHARACTER value replace the keyword "@GETMODIFIER@"
pcGuid CHARACTER
The CHARACTER value replace the keyword "@GUID@"
pcInheritance CHARACTER
The Inherited comment "@INHERITANCE@"
pcTemplateName CHARACTER
The template name which be loaded and manipulated.
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object.
Returns LONGCHAR
Return the manipulated template
Top

PUBLIC WriteMessage (character)
Purpose: Writes a message either to stdout (BATCH) or LOG-MANAGER
Notes:

Parameters:
pcMessage CHARACTER
The message to output


Temp-Table Detail


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:22:15