HeaderDoc::APIOwner
IntroductionIntermediate API object base class for classes, headers, packages, namespaces, and so on. DiscussionThe This class is a subclass of
This class is subclassed by
This API object type should never actually be emitted as output; only its subclasses are relevant. Member Functions
_createHTMLOutputFileCreates a file for HTML output. Parameters_createXMLOutputFileCreates a file for XML output. Parameters_getCategoryXMLDetailStringReturns the XML content string for categories in this class or header. ParametersDiscussionCalled by _getClassEmbeddedTOCReturns the embedded mini-TOC for classes. ParametersDiscussionThis function generates the embedded mini-TOC that appears at the top of the Classes section in the right-side content. This function is a wrapper for _getClassXMLDetailStringReturns the XML content string for classes in this class or header. ParametersDiscussionCalled by _getCompositePageStringGenerates output string for storing in the composite page. ParametersDiscussionThis function is called by _getConstantDetailStringReturns the right-side content for constants in this class or header. ParametersDiscussionCalled by _getConstantXMLDetailStringReturns the XML content string for constants in this class or header. ParametersDiscussionCalled by _getDetailStringReturns the right-side content for an array of objects. sub _getDetailString Parameters
_getDoxyTagStringReturns a Doxygen-style tagfile string. ParametersDiscussionCalled by _getEmbeddedTOCReturns an embedded mini-TOC. sub _getEmbeddedTOC Parameters
DiscussionThis function generates the embedded mini-TOC that appears at the top of various sections in the right-side content. _getEnumDetailStringReturns the right-side content for enums in this class or header. ParametersDiscussionCalled by _getEnumXMLDetailStringReturns the XML content string for enums in this class or header. ParametersDiscussionCalled by _getFunctionDetailStringReturns the right-side content for functions in this class or header. ParametersDiscussionCalled by _getFunctionXMLDetailStringReturns the XML content string for functions in this class or header. ParametersDiscussionCalled by _getMethodDetailStringReturns the right-side content for methods in this class or header. ParametersDiscussionCalled by _getMethodXMLDetailStringReturns the XML content string for methods in this class or header. ParametersDiscussionCalled by _getPDefineDetailStringReturns the right-side content for ParametersDiscussionCalled by _getPDefineXMLDetailStringReturns the XML content string for ParametersDiscussionCalled by _getPropDetailStringReturns the right-side content for properties in this class or header. ParametersDiscussionCalled by _getPropXMLDetailStringReturns the XML content string for properties in this class or header. ParametersDiscussionCalled by _getProtocolXMLDetailStringReturns the XML content string for protocols in this class or header. ParametersDiscussionCalled by _getStructDetailStringReturns the right-side content for structs in this class or header. ParametersDiscussionCalled by _getStructXMLDetailStringReturns the XML content string for structs in this class or header. ParametersDiscussionCalled by _getTypedefDetailStringReturns the right-side content for typedefs in this class or header. ParametersDiscussionCalled by _getTypedefXMLDetailStringReturns the XML content string for typedefs in this class or header. ParametersDiscussionCalled by _getVarDetailStringReturns the right-side content for variables in this class or header. ParametersDiscussionCalled by _getVarXMLDetailStringReturns the XML content string for variables in this class or header. ParametersDiscussionCalled by _getXMLPageStringGenerates output string for storing in an XML file. ParametersDiscussionThis function is called by _initializeInitializes an instance of an sub _initialize ParametersaddGroupAdds a group to an sub addGroup() Parameters
addToCategoriesAdds a category associated with this header. sub addToCategories Parameters
addToClassesAdds a class to class list sub addToClasses Parameters
DiscussionBoth headers and classes can contain classes (in some languages). This function is used for both cases. addToConstantsAdds a constant associated with this header or class. sub addToConstants Parameters
addToEnumsAdds an enum associated with this header or class. sub addToEnums Parameters
addToFunctionsAdds a function associated with this header or class. sub addToFunctions Parameters
addToGroupAdds an object to a group. sub addToGroup() ParametersDiscussionThis function looks up a group by name and manipulates the
associated addToMethodsAdds an Objective-C method associated with this class. sub addToMethods Parameters
addToPDefinesAdds a sub addToPDefines Parameters
addToPropsAdds a property associated with this class. sub addToProps Parameters
addToProtocolsAdds a protocol associated with this header. sub addToProtocols Parameters
addToStructsAdds a struct associated with this header or class. sub addToStructs Parameters
addToTypedefsAdds a typedef associated with this header or class. sub addToTypedefs Parameters
addToVarsAdds a variable associated with this header or class. sub addToVars Parameters
alsoIncludeGets/appends to the "also include" array. sub alsoInclude ParametersDiscussionThis is used with C pseudoclasses to tell the parser to also include certain function declarations as members. apiUIDPrefixGets/sets the value of the sub apiUIDPrefix ParametersappleRefUsedMarks an API reference ID as having been emitted already. sub appleRefUsed ParametersarrayToJSONPrivate function for an Apple-specific output format. sub arrayToJSON ParametersDiscussionConverts an array into JSON notation. availabilitySets and returns the availability of this class. sub availability ParameterscategoriesGets/sets the array of categories that are enclosed in this header. sub categories ParameterscategoriesDirGets/sets the path to the directory where category output should be written. sub categoriesDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Categories. CClassIndicates whether the class is a C pseudoclass. sub CClass ParametersclassesGets/sets the array of classes within this header (or enclosing class). sub classes ParametersclassesDirGets/sets the path to the directory where class output should be written. sub classesDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Classes. classTypeReturns the class type for the block parser. sub classType ParametersDiscussionReturns the class type in a form that the block parser needs when handling the enclosed elements. cloneDuplicates this sub clone ParameterscompositePageAPIRefReturns an apple_ref marker for a header/class composite page. ParameterscompositePageAPIUIDReturns an apple_ref UID for a header/class composite page. ParametersDiscussionCalled by compositePageNameGets/sets the filename that should be used for the composite page. ParametersDiscussionIn the default mode (iframe output), this returns the default frame name. This returns the value of the constantsGets/sets the array of constants that are enclosed in this header or class. sub constants ParametersconstantsDirGets/sets the path to the directory where constant output should be written. sub constantsDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Constants. copyrightOwnerGets/sets the copyright owner for the header,
specified by the sub copyrightOwner ParameterscreateContentFileGenerates the content HTML file (right-side frame). ParametersDiscussionIn "class as composite" mode, this function does not
get called. Instead, Otherwise, this function just writes the introduction
for the header or class itself, and the other
right-side content is written later by a call to
createFramesetFileCreates the index.html frameset file for a class or header. ParameterscreateTOCFileCreates the table of contents file (toc.html) for a class or header. sub createTOCFile ParameterscurrentClassGets/sets the last class added to this header (or class) object. sub currentClass ParametersDiscussionUsed for debugging purposes when dbprint() is called on the header object during processing. datatypesDirGets/sets the path to the directory where data type output should be written. sub datatypesDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/DataTypes. dbprintPrints information about this object for debugging purposes. sub dbprint ParametersdefaultFrameNameGets/sets the value of the sub defaultFrameName ParametersdocNavigatorCommentReturns a comment marker for
ParametersDiscussionOverridden by subclasses to return an HTML comment that identifies the
index file (Header vs. Class, name, and so on). The
encodingGets/sets the encoding information for this class or header. sub encoding ParametersenumsGets/sets the array of enums that are enclosed in this header or class. sub enums ParametersenumsDirGets/sets the path to the directory where enum output should be written. sub enumsDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Enums. explicitSuperGet/set whether superclass was specified in comment sub explicitSuper ParametersDiscussionIf the superclass is explicitly specified in the markup
with an fieldsGets/sets the array of fields that are associated with a C pseudoclass. sub fields ParametersfindClassReturns whether the header contains a class with a given name. sub findClass ParametersDiscussionUsed by the BlockParse code to check to see if a header contains a particular class. This is so that C++ methods outside the class braces (in a .cpp file) can be merged into the class. This could probably be replaced by a global symbol lookup for the class object now. findGroupSearches for a group associated with an sub findGroup ParametersReturn ValueReturns the fix_dateUpdates the dateStamp global variable. sub fix_date( $) fixupTypeRequestsTurns DiscussionFixes the case where the author requests freeAttempts to dispose of memory associated with this object. sub free ParametersfunctionsGets/sets the array of functions that are enclosed in this header or class. sub functions ParametersfunctionsDirGets/sets the path to the directory where function output should be written. sub functionsDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Functions. groupDocReturns the documentation block for groups. sub groupDoc() ParametersheaderObjectGets/sets the header containing a class, category, protocol, etc. sub headerObject ParametersDiscussionReturns a reference to the header associated with a class, category, protocol, or other API-owning structure. For a header, returns a reference to itself. htmlFooterGets/sets the value of the sub htmlFooter ParametershtmlHeaderGets/sets the value of the sub htmlHeader ParametersHTMLmetaReturns a string containing HTML meta tags for this header or class. sub HTMLmeta ParametersinarrayChecks for $name in $array referenced by $arrayref. sub inarray ParametersisAPIOwnerReturns whether an object is an sub isAPIOwner ParametersDiscussionOverrides the isCOMInterfaceReturns whether the class is a COM interface. sub isCOMInterface ParametersDiscussionReturns 1 if the class is a COM interface (a C pseudoclass
marked with the isFrameworkGet/set whether this file contains framework documentation sub isFramework ParametersDiscussionThis function returns true if the isMergedGet/set whether this class has had its superclass's members merged in yet (if applicable) sub isMerged ParametersisModuleGets/sets whether this class is a real class or a module sub isModule ParameterskeysToJSONPrivate function for an Apple-specific output format. sub keysToJSON ParametersDiscussionConverts a key in an associative array into a JSON key. When you call this, the surrounding JSON array should already be open. langSupportsAccessReturns whether access control is supported by the current programming language. Return ValueReturns methodsGets/sets the array of Objective-C methods that are enclosed in this class. sub methods ParametersmethodsDirGets/sets the path to the directory where method output should be written. sub methodsDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Methods. outputDirGets/sets the current output directory. sub outputDir ParametersDiscussionThis function returns the output directory (usually specified
by pDefinesGets/sets the array of sub pDefines ParameterspDefinesDirGets/sets the path to the directory where sub pDefinesDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/PDefines. printObjectPrints this object for debugging purposes. sub printObject ParametersprocessCommentProcesses a HeaderDoc comment for a class or header. sub processComment Parameters
propsGets/sets the array of properties that are enclosed in this class. sub props ParameterspropsDirGets/sets the path to the directory where property output should be written. sub propsDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Properties. protocolsGets/sets the array of protocols that are enclosed in this header. sub protocols ParametersprotocolsDirGets/sets the path to the directory where protocol output should be written. sub protocolsDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Protocols. removeFromCategoriesRemoves a maximum of one category per invocation. ParametersDiscussionA category gets removed if the higher level code successfully finds the associated class and adds the category methods to it. removeFromFunctionsRemoves a maximum of one function per invocation. ParametersDiscussionA function gets removed if it gets merged into a C
pseudoclass by an removeFromGroupRemoves an object from a group. sub removeFromGroup() ParametersDiscussionThis function looks up a group by name and manipulates the
associated removeFromPDefinesRemoves a maximum of one ParametersDiscussionA removeObjectRemoves a maximum of one object per invocation. sub removeObject ParametersDiscussionUsed by reparentModuleMembersDestroys any class objects associated with modules (which are not really classes, but can most easily be parsed as such). ParametersresetAppleRefUsedClears the API reference hash used by DiscussionThis is called when an API owner object needs to be emitted again (e.g. when a category's methods are folded into a class in another header). setupAPIReferencesRecursively ensures that the stripAppleRefsStrips apple_ref markup from the composite page output. sub stripAppleRefs ParametersDiscussionAn apple_ref marker is a named anchor that uniquely identifies each API symbol. For example, an Objective-C class named Foo would have the anchor <a name="//apple_ref/occ/cl/Foo"></a>. This markup is already in the primary documentation pages, so the duplicates must be removed from the composite pages. See the Symbol Markers for HTML-Based Documentation in HeaderDoc User Guide to learn more about apple_ref markup. striptitleStrips out nasty bits from titles. sub striptitle structsGets/sets the array of structs that are enclosed in this header or class. sub structs ParametersstructsDirGets/sets the path to the directory where struct output should be written. sub structsDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Structs. tocAccessReturns the HTML for an access heading (e.g. public, private) in the left-side TOC. sub tocAccess DiscussionPart of the new-style TOC code. tocAccessEndReturns the HTML for closing an access group (e.g. public, private) in the left-side TOC. sub tocAccessEnd DiscussionPart of the new-style TOC code. tocEntryReturns the HTML for a top-level entry in the left-side TOC. sub tocEntry DiscussionIn practice, this is used for the Overview section link and the link back to the enclosing header from a class. tocGroupReturns the HTML for a
sub tocGroup DiscussionPart of the new-style TOC code. tocGroupEndReturns the HTML for the end of a
sub tocGroupEnd DiscussionPart of the new-style TOC code. tocHeadingReturns the HTML for a TOC section heading. sub tocHeading DiscussionPart of the new-style TOC code. tocHeadingEndReturns the closing HTML tags to end a TOC section. sub tocHeadingEnd DiscussionPart of the new-style TOC code. tocJSONPrivate function for an Apple-specific output format. sub tocJSON Parameters
DiscussionGenerates a JSON-style table of contents. tocSeparatorReturns a TOC separator block. sub tocSeparator tocStringGenerates the HTML for the left-side TOC. sub tocString ParameterstocStringSubReturns the left-side TOC HTML for a set of data types, functions, methods, etc. sub tocStringSub DiscussionThis function takes an array of objects and generates the left-side TOC entries for those objects wrapped in appropriate HTML structures. This is similar to tocStringSubForClassesReturns the left-side TOC for the Classes box. DiscussionThis generates everything under the Classes section of the left-side TOC. This is similar to tocSubEntryReturns an entry for a single symbol in the left-side TOC. sub tocSubEntry DiscussionPart of the new-style TOC code. tocTitlePrefixGets/sets the prefix for the title line in the left-side TOC. sub tocTitlePrefix ParametersDiscussionReturns This value is set by the tocWrapSubEntriesReturns the structure for a grouping of symbols in the left-side TOC. DiscussionPart of the new-style TOC code. typedefsGets/sets the array of typedefs that are enclosed in this header or class. sub typedefs ParametersunsortedGets/sets whether TOC content for an API owner should be sorted or not. sub unsorted ParametersReturn ValueReturns the current value (after changing it, if necessary). DiscussionLegal values are 0 (sorted) and 1 (unsorted). updatedSets and returns the last updated date for this class or header. sub updated ParametersvarsGets/sets the array of variables that are enclosed in this header or class. sub vars ParametersvarsDirGets/sets the path to the directory where variable output should be written. sub varsDir ParametersDiscussionThis always contains [output_directory]/[this_header_directory]/Vars. writeCategoriesWrites the categories in a header object to a composite page. sub writeCategories ParameterswriteClassesWrites the right-side content for classes in this header (or class). sub writeClasses ParametersDiscussionCalled by writeConstantsWrites the right-side content for constants in this class or header. sub writeConstants ParametersDiscussionCalled by writeEnumsWrites the right-side content for enums in this class or header. sub writeEnums ParametersDiscussionCalled by writeFunctionListToStdOutWrites a list of functions to standard output. ParametersDiscussionThe format of this list is subject to change without notice. writeFunctionsWrites the right-side content for functions in this class or header. sub writeFunctions ParametersDiscussionCalled by writeHeaderElementsWrites the right-side content. ParametersDiscussionIn "class as composite" mode, this function's
purpose is handled by Otherwise, this function writes all of the
right-side content frames (e.g. Methods/Methods.html)
except for the introduction (which is written
by writeHeaderElementsToCompositePageWrites output to the composite page. ParametersDiscussionIn "class as composite" mode, this function supersedes
the function writeHeaderElementsToDoxyFileWrites a Doxygen-style tag file. ParametersDiscussionThis function does not write the final tag file. Instead, it writes a partial tag file that represents the contents of a single header. At the end of processing, HeaderDoc combines these into a single tag file. writeHeaderElementsToManPageWrites a series of manual pages for a header's functions. ParametersDiscussionThis function requires the xmlman binaries to be installed in /usr/bin. writeHeaderElementsToXMLPageWrites output to an XML file. ParameterswriteMethodsWrites the right-side content for methods in this class or header. sub writeMethods ParametersDiscussionCalled by writePDefinesWrites the right-side content for sub writePDefines ParametersDiscussionCalled by writePropsWrites the right-side content for properties in this class. sub writeProps ParametersDiscussionCalled by writeProtocolsWrites the protocols in a header object to a composite page. sub writeProtocols ParameterswriteStructsWrites the right-side content for structs in this class or header. sub writeStructs ParametersDiscussionCalled by writeTypedefsWrites the right-side content for typdefs in this class or header. sub writeTypedefs ParametersDiscussionCalled by writeVarsWrites the right-side content for variables in this class or header. sub writeVars ParametersDiscussionCalled by Member Data
ALSOINCLUDEContains an array of names of functions to "also include" in the documentation for this class/pseudoclass. Mainly intended for applying class-like behavior to procedural languages. $self->{ALSOINCLUDE}
APPLEREFUSEDA reference to a hash containing API references that have been emitted already in the context of this API owner. This is needed so that it can be reset if a class is re-emitted (after category folding, for example). $self->{APPLEREFUSED}
CATEGORIESAn array of
$self->{CATEGORIES}
CATEGORIESDIRThe directory where output will be written for categories
within this header. Set by $self->{CATEGORIESDIR}
CCLASSSet to 1 for a C pseudoclass, else 0. $self->{CCLASS}
CLASSESAn array of
$self->{CLASSES}
CLASSESDIRThe directory where output will be written for classes
within this header. Set by $self->{CLASSESDIR}
CONSTANTSDIRThe directory where output will be written for constants
within this header. Set by $self->{CONSTANTSDIR}
CURRENTCLASSThe last class added to this header (or class) object.
See $self->{CURRENTCLASS}
DATATYPESDIRThe directory where output will be written for data types
within this header. Set by $self->{DATATYPESDIR}
ENCODINGThe character encoding (guessed) for this header. $self->{ENCODING}
ENUMSAn array of
$self->{ENUMS}
ENUMSDIRThe directory where output will be written for enumerations
within this header. Set by $self->{ENUMSDIR}
EXPLICITSUPERSet to 1 if the superclass is specified explicitly with
the $self->{EXPLICITSUPER}
EXPORTINGFORDBDeprecated. $self->{EXPORTINGFORDB}
EXPORTSDIRThe directory where output will be written for database exports
from this header. Set by $self->{EXPORTSDIR}
FUNCTIONGROUPSTATEUsed during embedded markup processing to keep track of the most
recent $self->{FUNCTIONGROUPSTATE}
FUNCTIONSAn array of
$self->{FUNCTIONS}
FUNCTIONSDIRThe directory where output will be written for functions
within this header. Set by $self->{FUNCTIONSDIR}
GROUPSAn array of
$self->{GROUPS}
HeaderDoc::APIOwner::VERSIONThe revision control revision number for this module. $HeaderDoc::APIOwner::VERSION = '$Revision: 1340150018 $'; DiscussionIn the git repository, contains the number of seconds since January 1, 1970. HEADEROBJECTThe $self->{HEADEROBJECT}
ISFRAMEWORKSet to 1 if this object resulted from an $self->{ISFRAMEWORK}
ISMERGEDSet to 1 if this the superclass members have been merged
into this class (if applicable), else 0. See $self->{ISMERGED}
ISMODULESet to 1 if this class is actually a module in IDL. See $self->{ISMODULE}
METHODSAn array of
$self->{METHODS}
METHODSDIRThe directory where output will be written for methods
within this header. Set by $self->{METHODSDIR}
OUTPUTDIRThe output directory for this header. Set by $self->{OUTPUTDIR}
PDEFINESAn array of
$self->{PDEFINES}
PDEFINESDIRThe directory where output will be written for $self->{PDEFINESDIR}
PROPSAn array of
$self->{PROPS}
PROPSDIRThe directory where output will be written for properties
within this header. Set by $self->{PROPSDIR}
PROTOCOLSAn array of
$self->{PROTOCOLS}
PROTOCOLSDIRThe directory where output will be written for protocols
within this header. Set by $self->{PROTOCOLSDIR}
STRUCTSAn array of
$self->{STRUCTS}
STRUCTSDIRThe directory where output will be written for structs
within this header. Set by $self->{STRUCTSDIR}
TOCTITLEPREFIXThe prefix that precedes the name of the header or file
in the left-side table of contents. See $self->{TOCTITLEPREFIX}
TYPEDEFSAn array of
$self->{TYPEDEFS}
TYPEDEFSDIRThe directory where output will be written for typedefs
within this header. Set by $self->{TYPEDEFSDIR}
UNSORTEDStores whether the TOC for this API owner object should be
displayed without sorting. Use $self->{UNSORTED}
VARSDIRThe directory where output will be written for variables
within this header. Set by $self->{VARSDIR}
|