VhdlDocGen Class Reference

Enumerator:

ENTITYCLASS
PACKBODYCLASS
ARCHITECTURECLASS
PACKAGECLASS

Definition at line 43 of file vhdldocgen.h.

enum VhdlDocGen::VhdlKeyWords

Enumerator:

LIBRARY
ENTITY
PACKAGE_BODY
ARCHITECTURE
PACKAGE
ATTRIBUTE
SIGNAL
COMPONENT
CONSTANT
TYPE
SUBTYPE
FUNCTION
RECORD
PROCEDURE
USE
PROCESS
PORT
DOCUMENT
UNITS
GENERIC
PORTMAP

Definition at line 50 of file vhdldocgen.h.

VhdlDocGen::VhdlDocGen ( )

Definition at line 97 of file vhdldocgen.cpp.

VhdlDocGen::~VhdlDocGen ( ) [virtual]

Definition at line 101 of file vhdldocgen.cpp.

void VhdlDocGen::init ( ) [static]

Definition at line 105 of file vhdldocgen.cpp.

References QCString.

Entry * VhdlDocGen::getEntryAtLine	(	const Entry *	ce,
		int	line
	)			`[static]`

returns the parsed entry at line xxx

Definition at line 163 of file vhdldocgen.cpp.

References Entry::bodyLine, Entry::children(), and found.

QCString VhdlDocGen::getIndexWord	(	const char *	,
		int	index
	)			`[static]`

Definition at line 1053 of file vhdldocgen.cpp.

References QCString.

Referenced by parseFuncProto().

bool VhdlDocGen::foundInsertedComponent	(	const QCString &	name,
		Entry *	root
	)			`[static]`

Definition at line 2298 of file vhdldocgen.cpp.

References Entry::extends, and BaseInfo::name.

bool VhdlDocGen::deleteCharRev	(	QCString &	s,
		char	c
	)			`[static]`

deletes a char backwards in a string

Definition at line 1197 of file vhdldocgen.cpp.

Referenced by formatString(), isFunctionProto(), and parseFuncProto().

bool VhdlDocGen::isFunctionProto ( QCString & ss ) [static]

returns TRUE if this string is a function prototype or FALSE if this is a procedure

Definition at line 1601 of file vhdldocgen.cpp.

References compareString(), deleteCharRev(), and QCString.

Entry * VhdlDocGen::findFunction ( Entry * func ) [static]

void VhdlDocGen::deleteAllChars	(	QCString &	s,
		char	c
	)			`[static]`

Definition at line 1209 of file vhdldocgen.cpp.

Referenced by findFunction().

bool VhdlDocGen::getSigName	(	QList< QCString > &	ql,
		const char *	str,
		QCString &	buffer
	)			`[static]`

divides a port input in its name,direction and type

Parameters:

	ql	stores the input name(s)
	str	input string
	buffer	stores the input direction

Returns:: FALSE if it is a port

Definition at line 832 of file vhdldocgen.cpp.

References QCString.

Referenced by addSignals(), and getSigTypeName().

bool VhdlDocGen::getSigTypeName	(	QList< QCString > &	ql,
		const char *	str,
		QCString &	buffer
	)			`[static]`

Definition at line 814 of file vhdldocgen.cpp.

References getSigName(), and QCString.

void VhdlDocGen::parseFuncProto	(	const char *	text,
		QList< Argument > &	qlist,
		QCString &	name,
		QCString &	ret,
		bool	doc = `false`
	)			`[static]`

parses a function proto

Parameters:

	text	function string
	qlist	stores the function types
	name	points to the function name
	ret	Stores the return type
	doc	???

Definition at line 1001 of file vhdldocgen.cpp.

References deleteCharRev(), getIndexWord(), and QCString.

Referenced by VHDLLanguageScanner::parsePrototype().

void VhdlDocGen::debugClassName ( ClassSDict * ) [static]

Definition at line 182 of file vhdldocgen.cpp.

References ClassDef::className(), ClassDef::compoundTypeString(), ClassDef::definitionType(), Definition::documentation(), ClassDef::getFileBase(), ClassDef::getOutputFileBase(), ClassDef::getReference(), SDict< ClassDef >::Iterator, and QCString.

void VhdlDocGen::computeVhdlComponentRelations	(	const QDict< EntryNav > &	classEntries,
		FileStorage *	g_storage
	)			`[static]`

adds components to their entities

Definition at line 228 of file vhdldocgen.cpp.

References Doxygen::classSDict, Config_getBool, ENTITYCLASS, EntryNav::entry(), Entry::extends, EntryNav::fileDef(), FileDef::fileName(), g_storage, getClass(), getClassName(), ClassDef::insertBaseClass(), SDict< ClassDef >::Iterator, EntryNav::loadEntry(), BaseInfo::name, EntryNav::name(), Normal, ClassDef::protection(), Public, QCString, EntryNav::releaseEntry(), Entry::startLine, stripAnonymousNamespaceScope(), BaseInfo::virt, and warn().

QCString * VhdlDocGen::findKeyWord ( const QCString & word ) [static]

returns the color of a keyword

Definition at line 142 of file vhdldocgen.cpp.

Referenced by writeFormatString(), writeFunctionProto(), and writeProcedureProto().

void VhdlDocGen::addFuncDoc ( EntryNav * root ) [static]

Definition at line 613 of file vhdldocgen.cpp.

References Config_getBool, Entry::docLine, DOCUMENT, EntryNav::entry(), Entry::fileName, findFunction(), Entry::name, Entry::spec, and warn().

Referenced by writeDoc().

ClassDef * VhdlDocGen::findComponent ( int type ) [static]

Definition at line 279 of file vhdldocgen.cpp.

References Doxygen::classSDict, SDict< ClassDef >::Iterator, and ClassDef::protection().

ClassDef * VhdlDocGen::getPackageName ( const QCString & name ) [static]

Definition at line 292 of file vhdldocgen.cpp.

References getClass().

Referenced by findAllPackages(), and findMember().

MemberDef * VhdlDocGen::findMember	(	const QCString &	className,
		const QCString &	memName
	)			`[static]`

Definition at line 301 of file vhdldocgen.cpp.

References ARCHITECTURECLASS, findAllPackages(), findMemberDef(), getClass(), Definition::getOuterScope(), getPackageName(), PACKBODYCLASS, ClassDef::protection(), MemberList::pubMethods, QCString, DefinitionIntf::TypeClass, and MemberList::variableMembers.

Referenced by writeVHDLTypeDocumentation().

void VhdlDocGen::findAllPackages	(	const QCString &	className,
		QDict< QCString > &	qdict
	)			`[static]`

finds all included packages of an Entity or Package

Definition at line 394 of file vhdldocgen.cpp.

References getClass(), ClassDef::getMemberList(), getPackageName(), isPackage(), QCString, and MemberList::variableMembers.

Referenced by findMember().

MemberDef * VhdlDocGen::findMemberDef	(	ClassDef *	cd,
		const QCString &	key,
		MemberList::ListType	type
	)			`[static]`

This function returns the entity|package in which the key (type) is found

Definition at line 372 of file vhdldocgen.cpp.

References ClassDef::getMemberList(), and MemberDef::name.

Referenced by findMember().

ClassDef * VhdlDocGen::getClass ( const char * name ) [static]

Definition at line 213 of file vhdldocgen.cpp.

References Doxygen::classSDict, SDict< T >::find(), and QCString.

Referenced by computeVhdlComponentRelations(), findAllPackages(), findFunction(), findMember(), getPackageName(), writeInlineClassLink(), and writeVHDLDeclaration().

Entry * VhdlDocGen::findFunction	(	Entry *	root,
		Entry *	func
	)			`[static]`

returns the function with the matching argument list is called in vhdscan.l

Definition at line 503 of file vhdldocgen.cpp.

References Entry::argList, Entry::children(), compareString(), findFunction(), found, Entry::name, and Entry::spec.

MemberDef * VhdlDocGen::findFunction	(	const QList< Argument > &	ql,
		const QCString &	funcname,
		const QCString &	package,
		bool	type
	)			`[static]`

returns the function with the matching argument list is called in vhdlcode.l

Definition at line 437 of file vhdldocgen.cpp.

References Argument::attrib, compareString(), deleteAllChars(), FUNCTION, getClass(), ClassDef::getMemberList(), isProcedure(), isVhdlFunction(), MemberDef::name, LockingPtr< T >::pointer(), PROCEDURE, MemberList::pubMethods, QCString, and Argument::type.

bool VhdlDocGen::compareString	(	const QCString &	s1,
		const QCString &	s2
	)			`[static]`

Definition at line 806 of file vhdldocgen.cpp.

References QCString.

Referenced by findFunction(), and isFunctionProto().

QCString VhdlDocGen::getClassTitle ( const ClassDef * cd ) [static]

returns the class title+ref

Definition at line 633 of file vhdldocgen.cpp.

References ClassDef::displayName(), getClassName(), ClassDef::protection(), QCString, and theTranslator_vhdlType.

Referenced by ClassDef::writeDocumentation().

void VhdlDocGen::writeInlineClassLink	(	const ClassDef *	cd,
		OutputList &	ol
	)			`[static]`

writes an inline link form entity|package to architecture|package body and vice verca

Definition at line 673 of file vhdldocgen.cpp.

References ARCHITECTURE, ClassDef::className(), OutputList::disable(), OutputList::enable(), ENTITY, getClass(), OutputList::lineBreak(), OutputGenerator::Man, PACKAGE, PACKAGE_BODY, ClassDef::protection(), QCString, OutputGenerator::RTF, and theTranslator_vhdlType.

Referenced by writeVhdlDeclarations().

static bool VhdlDocGen::isLibrary ( const MemberDef * mdef ) [inline, static]

Definition at line 136 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and LIBRARY.

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isGeneric ( const MemberDef * mdef ) [inline, static]

Definition at line 138 of file vhdldocgen.h.

References GENERIC, and MemberDef::getMemberSpecifiers().

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isPort ( const MemberDef * mdef ) [inline, static]

Definition at line 140 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and PORT.

Referenced by writeVHDLDeclaration(), and writeVHDLTypeDocumentation().

static bool VhdlDocGen::isComponent ( const MemberDef * mdef ) [inline, static]

Definition at line 142 of file vhdldocgen.h.

References COMPONENT, and MemberDef::getMemberSpecifiers().

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isPackage ( const MemberDef * mdef ) [inline, static]

Definition at line 144 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and USE.

Referenced by findAllPackages(), and writeVHDLDeclaration().

static bool VhdlDocGen::isEntity ( const MemberDef * mdef ) [inline, static]

Definition at line 146 of file vhdldocgen.h.

References ENTITY, and MemberDef::getMemberSpecifiers().

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isConstant ( const MemberDef * mdef ) [inline, static]

Definition at line 148 of file vhdldocgen.h.

References CONSTANT, and MemberDef::getMemberSpecifiers().

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isVType ( const MemberDef * mdef ) [inline, static]

Definition at line 150 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and TYPE.

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isSubType ( const MemberDef * mdef ) [inline, static]

Definition at line 152 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and SUBTYPE.

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isVhdlFunction ( const MemberDef * mdef ) [inline, static]

Definition at line 154 of file vhdldocgen.h.

References FUNCTION, and MemberDef::getMemberSpecifiers().

Referenced by findFunction(), writeVHDLDeclaration(), and writeVHDLTypeDocumentation().

static bool VhdlDocGen::isProcess ( const MemberDef * mdef ) [inline, static]

Definition at line 156 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and PROCESS.

Referenced by writeFuncProcDocu(), writeVHDLDeclaration(), and writeVHDLTypeDocumentation().

static bool VhdlDocGen::isSignal ( const MemberDef * mdef ) [inline, static]

Definition at line 158 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and SIGNAL.

static bool VhdlDocGen::isAttribute ( const MemberDef * mdef ) [inline, static]

Definition at line 160 of file vhdldocgen.h.

References ATTRIBUTE, and MemberDef::getMemberSpecifiers().

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isSignals ( const MemberDef * mdef ) [inline, static]

Definition at line 162 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and SIGNAL.

Referenced by writeVHDLDeclaration().

static bool VhdlDocGen::isProcedure ( const MemberDef * mdef ) [inline, static]

Definition at line 164 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and PROCEDURE.

Referenced by findFunction(), writeFuncProcDocu(), writeVHDLDeclaration(), and writeVHDLTypeDocumentation().

static bool VhdlDocGen::isRecord ( const MemberDef * mdef ) [inline, static]

Definition at line 166 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and RECORD.

Referenced by addClassMemberNameToIndex(), and writeVHDLDeclaration().

static bool VhdlDocGen::isArchitecture ( const MemberDef * mdef ) [inline, static]

Definition at line 168 of file vhdldocgen.h.

References ARCHITECTURE, and MemberDef::getMemberSpecifiers().

static bool VhdlDocGen::isUnit ( const MemberDef * mdef ) [inline, static]

Definition at line 170 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and UNITS.

Referenced by addClassMemberNameToIndex().

static bool VhdlDocGen::isPackageBody ( const MemberDef * mdef ) [inline, static]

Definition at line 172 of file vhdldocgen.h.

References MemberDef::getMemberSpecifiers(), and PACKAGE_BODY.

QCString VhdlDocGen::trTypeString ( int type ) [static]

Definition at line 1164 of file vhdldocgen.cpp.

References ARCHITECTURE, ATTRIBUTE, COMPONENT, CONSTANT, DOCUMENT, ENTITY, FUNCTION, GENERIC, LIBRARY, PACKAGE, PACKAGE_BODY, PORT, PORTMAP, PROCEDURE, PROCESS, RECORD, SIGNAL, SUBTYPE, TYPE, UNITS, and USE.

Referenced by writeClassType(), and MemberDef::writeDocumentation().

QCString VhdlDocGen::trVhdlType	(	int	type,
		bool	sing = `true`
	)			`[static]`

Definition at line 2178 of file vhdldocgen.cpp.

References ARCHITECTURE, ATTRIBUTE, COMPONENT, CONSTANT, DOCUMENT, ENTITY, FUNCTION, GENERIC, LIBRARY, PACKAGE, PACKAGE_BODY, PORT, PROCEDURE, PROCESS, RECORD, SIGNAL, SUBTYPE, TYPE, UNITS, and USE.

Referenced by ClassSDict::writeDeclaration(), and ClassDef::writeMemberList().

QCString VhdlDocGen::trDesignUnitHierarchy ( ) [static]

Definition at line 2244 of file vhdldocgen.cpp.

Referenced by writeHierarchicalIndex().

QCString VhdlDocGen::trDesignUnitList ( ) [static]

Definition at line 2249 of file vhdldocgen.cpp.

Referenced by writeAnnotatedIndex().

QCString VhdlDocGen::trDesignUnitMembers ( ) [static]

Definition at line 2254 of file vhdldocgen.cpp.

QCString VhdlDocGen::trDesignUnitListDescription ( ) [static]

Definition at line 2259 of file vhdldocgen.cpp.

Referenced by writeAnnotatedIndex().

QCString VhdlDocGen::trDesignUnits ( ) [static]

Definition at line 2270 of file vhdldocgen.cpp.

QCString VhdlDocGen::trDesignUnitIndex ( ) [static]

Definition at line 2265 of file vhdldocgen.cpp.

Referenced by writeAlphabeticalIndex(), and writeIndex().

QCString VhdlDocGen::trFunctionAndProc ( ) [static]

Definition at line 2275 of file vhdldocgen.cpp.

Referenced by NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), and writeGroupTreeNode().

void VhdlDocGen::prepareComment ( QCString & qcs ) [static]

strips the "--" prefixes of vhdl comments

Definition at line 963 of file vhdldocgen.cpp.

References QCString.

static QCString VhdlDocGen::getpackname	(	const char *	text,
		const char *	word,
		const char *	patter
	)			`[static]`

void VhdlDocGen::parseProcessProto	(	const char *	text,
		QCString &	name,
		QStringList &	ql
	)			`[static]`

divides a process string in its name and types

Parameters:

	text	process text
	name	points to the process name
	ql	stores the process types

Definition at line 935 of file vhdldocgen.cpp.

References QCString.

void VhdlDocGen::formatString	(	QCString &	qcs,
		OutputList &	ol,
		const MemberDef *	mdef
	)			`[static]`

inserts white spaces for better readings and writes a colored string to the output

Definition at line 1335 of file vhdldocgen.cpp.

References deleteCharRev(), QCString, and writeFormatString().

Referenced by writeFunctionProto(), writeProcedureProto(), writeVHDLDeclaration(), and writeVHDLTypeDocumentation().

void VhdlDocGen::writeFormatString	(	QCString &	qcs,
		OutputList &	ol,
		const MemberDef *	mdef
	)			`[static]`

writes a colored and formatted string

Definition at line 1253 of file vhdldocgen.cpp.

References OutputList::endBold(), findKeyWord(), QCString, and OutputList::startBold().

Referenced by formatString(), writeFuncProcDocu(), and writeProcessProto().

void VhdlDocGen::writeFunctionProto	(	OutputList &	ol,
		const ArgumentList *	al,
		const MemberDef *	mdef
	)			`[static]`

writes a function prototype to the output

Definition at line 1447 of file vhdldocgen.cpp.

References Argument::defval, OutputList::docify(), OutputList::endBold(), findKeyWord(), formatString(), OutputList::lineBreak(), Argument::name, QCString, OutputList::startBold(), and Argument::type.

Referenced by writeVHDLDeclaration().

void VhdlDocGen::writeProcessProto	(	OutputList &	ol,
		const ArgumentList *	al,
		const MemberDef *	mdef
	)			`[static]`

writes a process prototype to the output

Definition at line 1507 of file vhdldocgen.cpp.

References OutputList::docify(), OutputList::endBold(), Argument::name, QCString, OutputList::startBold(), and writeFormatString().

Referenced by writeVHDLDeclaration().

void VhdlDocGen::writeProcedureProto	(	OutputList &	ol,
		const ArgumentList *	al,
		const MemberDef *	mdef
	)			`[static]`

writes a procedure prototype to the output

Definition at line 1393 of file vhdldocgen.cpp.

References Argument::attrib, Argument::defval, OutputList::docify(), OutputList::endBold(), findKeyWord(), formatString(), OutputList::lineBreak(), Argument::name, QCString, OutputList::startBold(), Argument::type, and OutputList::writeChar().

Referenced by writeVHDLDeclaration().

void VhdlDocGen::writeFuncProcDocu	(	const MemberDef *	md,
		OutputList &	ol,
		const ArgumentList *	al,
		bool	type = `false`
	)			`[static]`

writes a function|procedure documentation to the output

Definition at line 1533 of file vhdldocgen.cpp.

References Argument::attrib, Argument::defval, OutputList::disable(), OutputList::docify(), OutputList::enable(), OutputList::enableAll(), OutputList::endEmphasis(), OutputList::endParameterName(), isProcedure(), isProcess(), OutputGenerator::Man, Argument::name, QCString, OutputList::startEmphasis(), OutputList::startParameterList(), OutputList::startParameterType(), Argument::type, and writeFormatString().

Referenced by writeVHDLTypeDocumentation().

static void VhdlDocGen::writeRecordProto	(	const MemberDef *	mdef,
		OutputList &	ol,
		const ArgumentList *	al
	)			`[static]`

QCString VhdlDocGen::convertArgumentListToString	(	const ArgumentList *	al,
		bool	f
	)			`[static]`

Definition at line 1627 of file vhdldocgen.cpp.

References Argument::attrib, Argument::defval, Argument::name, QCString, and Argument::type.

Referenced by writeVHDLDeclaration().

QCString VhdlDocGen::getProcessNumber ( ) [static]

returns the next number of an anonymous process

Definition at line 1239 of file vhdldocgen.cpp.

References QCString.

QCString VhdlDocGen::getRecordNumber ( ) [static]

returns the next number of a record|unit member

Definition at line 1227 of file vhdldocgen.cpp.

References QCString.

Referenced by addSignals().

void VhdlDocGen::writeVHDLTypeDocumentation	(	const MemberDef *	mdef,
		const Definition *	d,
		OutputList &	ol
	)			`[static]`

Definition at line 1693 of file vhdldocgen.cpp.

References OutputList::docify(), OutputList::endBold(), findMember(), formatString(), ClassDef::getOutputFileBase(), ClassDef::getReference(), MemberDef::isLinkable(), isPort(), isProcedure(), isProcess(), isVhdlFunction(), ClassDef::name, QCString, OutputList::startBold(), writeFuncProcDocu(), and OutputList::writeObjectLink().

Referenced by MemberDef::writeDocumentation().

void VhdlDocGen::writeVhdlDeclarations	(	MemberList *	,
		OutputList &	,
		GroupDef *	,
		ClassDef *
	)			`[static]`

Definition at line 1656 of file vhdldocgen.cpp.

References ATTRIBUTE, COMPONENT, CONSTANT, FUNCTION, GENERIC, LIBRARY, PORT, PROCEDURE, PROCESS, RECORD, SIGNAL, SUBTYPE, theTranslator_vhdlType, TYPE, UNITS, USE, writeInlineClassLink(), and writeVHDLDeclarations().

void VhdlDocGen::writeVHDLDeclaration	(	MemberDef *	mdef,
		OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd,
		bool	inGroup
	)			`[static]`

Definition at line 1737 of file vhdldocgen.cpp.

References SearchIndex::addWord(), MemberDef::anchor, MemberDef::argsString(), MemberDef::argumentList(), ATTRIBUTE, Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), COMPONENT, Config_getBool, Config_getString, CONSTANT, convertArgumentListToString(), convertToXML(), OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enable(), OutputList::endBold(), OutputList::endDoxyAnchor(), OutputList::endMemberDescription(), OutputList::endMemberItem(), OutputList::endTextLink(), ENTITY, ENTITYCLASS, formatString(), FUNCTION, GENERIC, getClass(), MemberDef::getClassDefOfAnonymousType(), MemberDef::getMemberSpecifiers(), Definition::getOuterScope(), ClassDef::getOutputFileBase(), MemberDef::getOutputFileBase(), ClassDef::getReference(), OutputGenerator::Html, Doxygen::htmlFileExtension, OutputList::insertMemberAlign(), isAttribute(), isComponent(), isConstant(), MemberDef::isDetailedSectionLinkable(), OutputList::isEnabled(), isEntity(), isGeneric(), isLibrary(), isPackage(), isPort(), isProcedure(), isProcess(), isRecord(), isSignals(), isSubType(), isVhdlFunction(), isVType(), OutputGenerator::Latex, LIBRARY, Definition::localName(), OutputGenerator::Man, MemberDef::name, Definition::name(), PACKAGE, OutputList::parseDoc(), LockingPtr< T >::pointer(), OutputList::popGeneratorState(), PORT, PROCEDURE, PROCESS, ClassDef::protection(), OutputList::pushGeneratorState(), QCString, MemberDef::qualifiedName(), RECORD, Doxygen::searchIndex, SearchIndex::setCurrentDoc(), SIGNAL, OutputList::startBold(), OutputList::startDoxyAnchor(), OutputList::startMemberDescription(), OutputList::startMemberItem(), OutputList::startTextLink(), SUBTYPE, Doxygen::tagFile, theTranslator_vhdlType, TYPE, MemberDef::typeString(), UNITS, USE, MemberDef::warnIfUndocumented(), writeFunctionProto(), writeProcedureProto(), and writeProcessProto().

Referenced by writePlainVHDLDeclarations().

void VhdlDocGen::writePlainVHDLDeclarations	(	MemberList *	ml,
		OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd,
		int	specifier
	)			`[static]`

Definition at line 2027 of file vhdldocgen.cpp.

References SDict< T >::append(), SDict< T >::clear(), OutputList::endMemberList(), SDict< T >::find(), MemberDef::getMemberSpecifiers(), MemberDef::isBriefSectionVisible(), LIBRARY, MemberDef::name, OutputList::pushGeneratorState(), QCString, OutputList::startMemberList(), and writeVHDLDeclaration().

Referenced by writeVHDLDeclarations().

void VhdlDocGen::writeVHDLDeclarations	(	MemberList *	ml,
		OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd,
		const char *	title,
		const char *	subtitle,
		bool	showEnumValues,
		int	type
	)			`[static]`

QCString VhdlDocGen::getClassName ( const ClassDef * ) [static]

Definition at line 648 of file vhdldocgen.cpp.

References ClassDef::className(), ClassDef::name, PACKBODYCLASS, ClassDef::protection(), QCString, and substitute().

Referenced by computeVhdlComponentRelations(), ClassDef::displayName(), getClassTitle(), and writeClassType().

bool VhdlDocGen::writeClassType	(	ClassDef *&	,
		OutputList &	ol,
		QCString &	cname
	)			`[static]`

Definition at line 2160 of file vhdldocgen.cpp.

References OutputList::endBold(), getClassName(), ClassDef::protection(), QCString, OutputList::startBold(), trTypeString(), and OutputList::writeString().

Referenced by ClassSDict::writeDeclaration().

void VhdlDocGen::adjustRecordMember ( MemberDef * mdef ) [static]

Definition at line 2146 of file vhdldocgen.cpp.

References MemberDef::name, QCString, and Definition::setName().

Referenced by addClassMemberNameToIndex().

bool VhdlDocGen::writeDoc ( EntryNav * rootNav ) [static]

adds documentation to a function/procedure

Definition at line 2283 of file vhdldocgen.cpp.

References addFuncDoc(), EntryNav::entry(), and Entry::type.


Public Types
enum	VhdlClasses { ENTITYCLASS, PACKBODYCLASS, ARCHITECTURECLASS, PACKAGECLASS }
enum	VhdlKeyWords { LIBRARY = 1, ENTITY, PACKAGE_BODY, ARCHITECTURE, PACKAGE, ATTRIBUTE, SIGNAL, COMPONENT, CONSTANT, TYPE, SUBTYPE, FUNCTION, RECORD, PROCEDURE, USE, PROCESS, PORT, DOCUMENT, UNITS, GENERIC, PORTMAP }
Public Member Functions
	VhdlDocGen ()
virtual	~VhdlDocGen ()
Static Public Member Functions
static void	init ()
static Entry *	getEntryAtLine (const Entry *e, int line)
static QCString	getIndexWord (const char *, int index)
static bool	foundInsertedComponent (const QCString &name, Entry *root)
static bool	deleteCharRev (QCString &s, char c)
static bool	isFunctionProto (QCString &ss)
static Entry *	findFunction (Entry *func)
static void	deleteAllChars (QCString &s, char c)
static bool	getSigName (QList< QCString > &ql, const char *str, QCString &buffer)
static bool	getSigTypeName (QList< QCString > &ql, const char *str, QCString &buffer)
static void	parseFuncProto (const char *text, QList< Argument > &, QCString &name, QCString &ret, bool doc=false)
static void	debugClassName (ClassSDict *)
static void	computeVhdlComponentRelations (const QDict< EntryNav > &, FileStorage *)
static QCString *	findKeyWord (const QCString &word)
static void	addFuncDoc (EntryNav *root)
static ClassDef *	findComponent (int type)
static ClassDef *	getPackageName (const QCString &name)
static MemberDef *	findMember (const QCString &className, const QCString &memName)
static void	findAllPackages (const QCString &className, QDict< QCString > &)
static MemberDef *	findMemberDef (ClassDef *cd, const QCString &key, MemberList::ListType type)
static ClassDef *	getClass (const char *name)
static Entry *	findFunction (Entry root, Entry func)
static MemberDef *	findFunction (const QList< Argument > &ql, const QCString &name, const QCString &package, bool type)
static bool	compareString (const QCString &s1, const QCString &s2)
static QCString	getClassTitle (const ClassDef *)
static void	writeInlineClassLink (const ClassDef *, OutputList &ol)
static bool	isLibrary (const MemberDef *mdef)
static bool	isGeneric (const MemberDef *mdef)
static bool	isPort (const MemberDef *mdef)
static bool	isComponent (const MemberDef *mdef)
static bool	isPackage (const MemberDef *mdef)
static bool	isEntity (const MemberDef *mdef)
static bool	isConstant (const MemberDef *mdef)
static bool	isVType (const MemberDef *mdef)
static bool	isSubType (const MemberDef *mdef)
static bool	isVhdlFunction (const MemberDef *mdef)
static bool	isProcess (const MemberDef *mdef)
static bool	isSignal (const MemberDef *mdef)
static bool	isAttribute (const MemberDef *mdef)
static bool	isSignals (const MemberDef *mdef)
static bool	isProcedure (const MemberDef *mdef)
static bool	isRecord (const MemberDef *mdef)
static bool	isArchitecture (const MemberDef *mdef)
static bool	isUnit (const MemberDef *mdef)
static bool	isPackageBody (const MemberDef *mdef)
static QCString	trTypeString (int type)
static QCString	trVhdlType (int type, bool sing=true)
static QCString	trDesignUnitHierarchy ()
static QCString	trDesignUnitList ()
static QCString	trDesignUnitMembers ()
static QCString	trDesignUnitListDescription ()
static QCString	trDesignUnits ()
static QCString	trDesignUnitIndex ()
static QCString	trFunctionAndProc ()
static void	prepareComment (QCString &)
static QCString	getpackname (const char text, const char word, const char *patter)
static void	parseProcessProto (const char *text, QCString &, QStringList &)
static void	formatString (QCString &, OutputList &ol, const MemberDef *)
static void	writeFormatString (QCString &, OutputList &ol, const MemberDef *)
static void	writeFunctionProto (OutputList &ol, const ArgumentList al, const MemberDef )
static void	writeProcessProto (OutputList &ol, const ArgumentList al, const MemberDef )
static void	writeProcedureProto (OutputList &ol, const ArgumentList al, const MemberDef )
static void	writeFuncProcDocu (const MemberDef mdef, OutputList &ol, const ArgumentList al, bool type=false)
static void	writeRecordProto (const MemberDef mdef, OutputList &ol, const ArgumentList al)
static QCString	convertArgumentListToString (const ArgumentList *al, bool f)
static QCString	getProcessNumber ()
static QCString	getRecordNumber ()
static void	writeVHDLTypeDocumentation (const MemberDef mdef, const Definition d, OutputList &ol)
static void	writeVhdlDeclarations (MemberList , OutputList &, GroupDef , ClassDef *)
static void	writeVHDLDeclaration (MemberDef mdef, OutputList &ol, ClassDef cd, NamespaceDef nd, FileDef fd, GroupDef *gd, bool inGroup)
static void	writePlainVHDLDeclarations (MemberList ml, OutputList &ol, ClassDef cd, NamespaceDef nd, FileDef fd, GroupDef *gd, int specifier)
static void	writeVHDLDeclarations (MemberList ml, OutputList &ol, ClassDef cd, NamespaceDef nd, FileDef fd, GroupDef gd, const char title, const char *subtitle, bool showEnumValues, int type)
static QCString	getClassName (const ClassDef *)
static bool	writeClassType (ClassDef *&, OutputList &ol, QCString &cname)
static void	adjustRecordMember (MemberDef *mdef)
static bool	writeDoc (EntryNav *rootNav)

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation