Pike v8.1 release 6

Class Tools.AutoDoc.DocParser.MetaData

Description

Metadata about a Documentation object.


Variable belongs
Variable appears

string Tools.AutoDoc.DocParser.MetaData.belongs
string Tools.AutoDoc.DocParser.MetaData.appears

Description

Relocation information.


Variable decls

array(PikeObject) Tools.AutoDoc.DocParser.MetaData.decls

Description

Set of declarations.


Variable inherits

array(PikeObject) Tools.AutoDoc.DocParser.MetaData.inherits

Description

Set of inherits.


Variable name

string Tools.AutoDoc.DocParser.MetaData.name

Description

If type is one of "class", "module", "endmodule", or "endclass".


Variable type

string Tools.AutoDoc.DocParser.MetaData.type

Description

Type of documented entity.