Namespace: Consultingwerk.Studio.ClassDocumentation
Interface 
ICustomDocumentationHeaderProvider Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.Studio.SmartDox.CustomDocumentationHeaderProvider

File:ICustomDocumentationHeaderProvider
Purpose:Interface for services providing HTML markup for custom
information injected into individual class reference pages
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Apr 12 12:03:56 CEST 2017
Notes:Used to replace the place holder in
the Document.template
Purpose: Returns the custom header information for a given class
Notes: Method is expected to return HTML markup, typically surrounded
by <span> </span>

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



Top Method Summary
Options Name Purpose
+ LONGCHAR GetAdditionalHeaderInformation (character, character) Returns the custom header information for a given class


Method Detail
Top

PUBLIC LONGCHAR GetAdditionalHeaderInformation (character, character)
Purpose: Returns the custom header information for a given class
Notes: Method is expected to return HTML markup, typically surrounded
by <span> </span>

Parameters:
pcClassName CHARACTER
The name of the class to provide custom header information for
pcOutputDir CHARACTER
The output directory (to copy additional resources to)
Returns LONGCHAR
The HTML markup for the additional documentation header


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