GDDocumentable Interface Reference

Inherited by GDClassImpl, GDOperationImpl, and GDParameterImpl.

Public Member Functions
Function	getDocumentBlock () As String
Function	getDocumentSection () As String
Function	getDocumentSectionLength () As Long
Function	getDocumentSectionStart () As Long
Function	getDoxyCommands () As GDDoxyCommands
	Retrieve the Commands defined for the Documentable Object.
Function	getKey () As String
Sub	storeDescription ()
	Store the Documentable Object description.
Sub	writeDocumentation ()
	Write the Documentable information of the implementation object.

Detailed Description

Copyright

VBDoxyAddin by javacioc is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License. Based on a work at http://sourceforge.net/p/vbdoxyaddin.

Member Function Documentation

Function GDDocumentable::getDocumentBlock

(

)

Return values

String

Function GDDocumentable::getDocumentSection

(

)

Return values

String

Function GDDocumentable::getDocumentSectionLength

(

)

Return values

Long

Function GDDocumentable::getDocumentSectionStart

(

)

Return values

Long

Function GDDocumentable::getDoxyCommands

(

)

Retrieve the Commands defined for the Documentable Object.

Return values

GDDoxyCommands

Function GDDocumentable::getKey

(

)

Return values

String

Sub GDDocumentable::storeDescription

(

)

Store the Documentable Object description.

The tags will be used to form the complete description of the Documentable Object. The stored description will be visible into the Object Browser of the VB IDE.

Sub GDDocumentable::writeDocumentation

(

)

Write the Documentable information of the implementation object.

Depending on the type of Object is implementing this interface this operation will write the information on the top of Class or on the the top of Operation.