VhdlDocGen类 参考

Class for generating documentation specific for VHDL 更多...

#include <vhdldocgen.h>

Public 类型
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, UNITS, GENERIC, INSTANTIATION,   GROUP, VFILE, SHAREDVARIABLE, CONFIG,   ALIAS, MISCELLANEOUS, UCF_CONST }

Public 成员函数
	VhdlDocGen ()
virtual	~VhdlDocGen ()

静态 Public 成员函数
static void	init ()
static QCString	convertFileNameToClassName (QCString name)
static bool	isSubClass (ClassDef *cd, ClassDef *scd, bool followInstances, int level)
static QCString	getIndexWord (const QCString &, int index)
static bool	deleteCharRev (QCString &s, char c)
static void	deleteAllChars (QCString &s, char c)
static void	parseFuncProto (const QCString &text, QCString &name, QCString &ret, bool doc=false)
static void	computeVhdlComponentRelations ()
static const char *	findKeyWord (const QCString &word)
static ClassDef *	getPackageName (const QCString &name)
static const MemberDef *	findMember (const QCString &className, const QCString &memName)
static void	findAllPackages (ClassDef *)
static const MemberDef *	findMemberDef (ClassDef *cd, const QCString &key, MemberListType type)
	This function returns the entity|package in which the key (type) is found 更多...
static ClassDef *	getClass (const QCString &name)
static const MemberDef *	findFunction (const QCString &name, const QCString &package)
static QCString	getClassTitle (const ClassDef *)
static void	writeInlineClassLink (const ClassDef *, OutputList &ol)
static void	writeTagFile (MemberDefMutable *mdef, TextStream &tagFile)
static bool	isConstraint (const MemberDef *mdef)
static bool	isConfig (const MemberDef *mdef)
static bool	isAlias (const MemberDef *mdef)
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 bool	isVariable (const MemberDef *mdef)
static bool	isFile (const MemberDef *mdef)
static bool	isGroup (const MemberDef *mdef)
static bool	isCompInst (const MemberDef *mdef)
static bool	isMisc (const MemberDef *mdef)
static void	prepareComment (QCString &)
static void	formatString (const QCString &, OutputList &ol, const MemberDef *)
static void	writeFormatString (const 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 bool	writeFuncProcDocu (const MemberDef *mdef, OutputList &ol, const ArgumentList &al, bool type=false)
static void	writeRecordProto (const MemberDef *mdef, OutputList &ol, const ArgumentList &al)
static bool	writeVHDLTypeDocumentation (const MemberDef *mdef, const Definition *d, OutputList &ol)
static void	writeVhdlDeclarations (const MemberList *, OutputList &, const GroupDef *, const ClassDef *, const FileDef *, const NamespaceDef *)
static void	writeVHDLDeclaration (const MemberDefMutable *mdef, OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool inGroup)
static void	writePlainVHDLDeclarations (const MemberList *ml, OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, uint64_t specifier)
static void	writeVHDLDeclarations (const MemberList *ml, OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const QCString &title, const QCString &subtitle, bool showEnumValues, int type)
static bool	writeClassType (const ClassDef *, OutputList &ol, QCString &cname)
static QCString	convertArgumentListToString (const ArgumentList &al, bool f)
static QCString	getProcessNumber ()
static QCString	getRecordNumber ()
static QCString	getClassName (const ClassDef *)
static bool	isNumber (const std::string &s)
static QCString	getProtectionName (int prot)
static void	parseUCF (const char *input, Entry *entity, const QCString &f, bool vendor)
static const ClassDef *	findArchitecture (const ClassDef *cd)
static void	correctMemberProperties (MemberDefMutable *md)
static void	writeSource (const MemberDefMutable *mdef, OutputList &ol, const QCString &cname)
static QCString	parseForConfig (QCString &entity, QCString &arch)
static QCString	parseForBinding (QCString &entity, QCString &arch)
static void	addBaseClass (ClassDef *cd, ClassDef *ent)
static ClassDef *	findVhdlClass (const QCString &className)
static void	writeOverview (OutputList &ol)
static void	writeOverview ()
static void	createFlowChart (const MemberDef *)
static void	setFlowMember (const MemberDef *flowMember)
static const MemberDef *	getFlowMember ()
static bool	isVhdlClass (const Entry *cu)
static void	resetCodeVhdlParserState ()

静态 Private 成员函数
static void	findAllArchitectures (std::vector< QCString > &ql, const ClassDef *cd)
static bool	compareArgList (const ArgumentList &, const ArgumentList &)
static void	writeVhdlLink (const ClassDef *cdd, OutputList &ol, QCString &type, QCString &name, QCString &beh)
static void	writeStringLink (const MemberDef *mdef, QCString mem, OutputList &ol)
static void	writeRecUnitDocu (const MemberDef *md, OutputList &ol, QCString largs)
static void	writeRecordUnit (QCString &largs, QCString &ltype, OutputList &ol, const MemberDefMutable *mdef)

详细描述

Class for generating documentation specific for VHDL

在文件 vhdldocgen.h 第 68 行定义.

成员枚举类型说明

VhdlClasses

enum VhdlDocGen::VhdlClasses

枚举值
ENTITYCLASS
PACKBODYCLASS
ARCHITECTURECLASS
PACKAGECLASS

在文件 vhdldocgen.h 第 72 行定义.

    {
      ENTITYCLASS,         // Overlays: Public
      PACKBODYCLASS,       // Overlays: Protected
      ARCHITECTURECLASS,   // Overlays: Private
      PACKAGECLASS         // Overlays: Package
    };

VhdlKeyWords

enum VhdlDocGen::VhdlKeyWords

枚举值
LIBRARY
ENTITY
PACKAGE_BODY
ARCHITECTURE
PACKAGE
ATTRIBUTE
SIGNAL
COMPONENT
CONSTANT
TYPE
SUBTYPE
FUNCTION
RECORD
PROCEDURE
USE
PROCESS
PORT
UNITS
GENERIC
INSTANTIATION
GROUP
VFILE
SHAREDVARIABLE
CONFIG
ALIAS
MISCELLANEOUS
UCF_CONST

在文件 vhdldocgen.h 第 80 行定义.

    {
      LIBRARY=1,
      ENTITY,
      PACKAGE_BODY,
      ARCHITECTURE,
      PACKAGE,
      ATTRIBUTE,
      SIGNAL,
      COMPONENT,
      CONSTANT,
      TYPE,
      SUBTYPE,
      FUNCTION,
      RECORD,
      PROCEDURE,
      USE,
      PROCESS,
      PORT,
      UNITS,
      GENERIC,
      INSTANTIATION,
      GROUP,
      VFILE,
      SHAREDVARIABLE,
      CONFIG,
      ALIAS,
      MISCELLANEOUS,
      UCF_CONST
    };

构造及析构函数说明

VhdlDocGen()

VhdlDocGen::VhdlDocGen

(

)

在文件 vhdldocgen.cpp 第 498 行定义.

{
}

~VhdlDocGen()

VhdlDocGen::~VhdlDocGen ( )

virtual

在文件 vhdldocgen.cpp 第 502 行定义.

{
}

成员函数说明

addBaseClass()

void VhdlDocGen::addBaseClass ( ClassDef *  cd, ClassDef *  ent  )

static

在文件 vhdldocgen.cpp 第 2696 行定义.

{
  BaseClassList bcl = cd->baseClasses();
  for (auto &bcd : bcl)
  {
    ClassDef *ccd = bcd.classDef;
    if (ccd==ent)
    {
      QCString n = bcd.usedName;
      int i = n.find('(');
      if(i<0)
      {
        bcd.usedName.append("(2)");
        return;
      }
      static const reg::Ex reg(R"(\d+)");
      QCString s=n.left(i);
      QCString r=n.right(n.length()-i);
      std::string t=r.str();
      VhdlDocGen::deleteAllChars(r,')');
      VhdlDocGen::deleteAllChars(r,'(');
      r.setNum(r.toInt()+1);
      reg::replace(t, reg, r.str());
      s.append(t.c_str());
      bcd.usedName=s;
      bcd.templSpecifiers=t;
    }
  }
  cd->updateBaseClasses(bcl);
}

引用了 QCString::append(), ClassDef::baseClasses(), deleteAllChars(), QCString::find(), QCString::left(), QCString::length(), reg::replace(), QCString::right(), QCString::setNum(), QCString::str(), QCString::toInt() , 以及 ClassDef::updateBaseClasses().

被这些函数引用 addInstance().

compareArgList()

static bool VhdlDocGen::compareArgList ( const ArgumentList &  , const ArgumentList &    )

staticprivate

computeVhdlComponentRelations()

void VhdlDocGen::computeVhdlComponentRelations ( )

static

在文件 vhdldocgen.cpp 第 2501 行定义.

{
 
  QCString entity,arch,inst;
 
  for (const auto &cur : getVhdlInstList())
  {
    if (cur->stat ) //  was bind
    {
      continue;
    }
 
    if (cur->includeName=="entity" || cur->includeName=="component" )
    {
      entity=cur->includeName+" "+cur->type;
      QCString rr=VhdlDocGen::parseForBinding(entity,arch);
    }
    else if (cur->includeName.isEmpty())
    {
      entity=cur->type;
    }
 
    ClassDefMutable *classEntity= toClassDefMutable(VhdlDocGen::findVhdlClass(entity));
    inst=VhdlDocGen::getIndexWord(cur->args,0);
    ClassDefMutable *cd=toClassDefMutable(Doxygen::classLinkedMap->find(inst));
    ClassDefMutable *ar=toClassDefMutable(Doxygen::classLinkedMap->find(cur->args));
 
    if (cd==0)
    {
      continue;
    }
 
    // if (classEntity==0)
    //   err("%s:%d:Entity:%s%s",qPrint(cur->fileName),cur->startLine,qPrint(entity)," could not be found");
 
    addInstance(classEntity,ar,cd,cur);
  }
 
}

引用了 addInstance(), Doxygen::classLinkedMap, findVhdlClass(), getIndexWord(), getVhdlInstList(), parseForBinding() , 以及 toClassDefMutable().

被这些函数引用 parseInput().

convertArgumentListToString()

QCString VhdlDocGen::convertArgumentListToString ( const ArgumentList &  al, bool  f  )

static

在文件 vhdldocgen.cpp 第 1512 行定义.

{
  QCString argString;
  bool sem=FALSE;
 
  for (const Argument &arg : al)
  {
    if (sem) argString.append(", ");
    if (func)
    {
      argString+=arg.name;
      argString+=":";
      argString+=arg.type;
    }
    else
    {
      argString+=arg.defval+" ";
      argString+=arg.name+" :";
      argString+=arg.attrib+" ";
      argString+=arg.type;
    }
    sem=TRUE;
  }
  return argString;
}

引用了 QCString::append(), FALSE , 以及 TRUE.

被这些函数引用 writeTagFile().

convertFileNameToClassName()

QCString VhdlDocGen::convertFileNameToClassName ( QCString  name )

static

在文件 vhdldocgen.cpp 第 2245 行定义.

{
 
  QCString n=name;
  n=n.remove(0,6);
 
  int i=0;
 
  while((i=n.find("__"))>0)
  {
    n=n.remove(i,1);
  }
 
  while((i=n.find("_1"))>0)
  {
    n=n.replace(i,2,":");
  }
 
  return n;
}

引用了 QCString::find(), QCString::remove() , 以及 QCString::replace().

correctMemberProperties()

void VhdlDocGen::correctMemberProperties ( MemberDefMutable *  md )

static

在文件 vhdldocgen.cpp 第 1570 行定义.

{
  if (md->argsString()=="package")
  {
    md->setMemberSpecifiers(VhdlDocGen::INSTANTIATION);
  }
  else if (md->argsString()=="configuration")
  {
    md->setMemberSpecifiers(VhdlDocGen::CONFIG);
  }
  else if (md->typeString()=="library")
  {
    md->setMemberSpecifiers(VhdlDocGen::LIBRARY);
  }
  else if (md->typeString()=="use")
  {
    md->setMemberSpecifiers(VhdlDocGen::USE);
  }
  else if (md->typeString().lower()=="misc")
  {
    md->setMemberSpecifiers(VhdlDocGen::MISCELLANEOUS);
  }
  else if (md->typeString().lower()=="ucf_const")
  {
    md->setMemberSpecifiers(VhdlDocGen::UCF_CONST);
  }
 
  if (md->getMemberSpecifiers()==VhdlDocGen::UCF_CONST)
  {
    int mm=md->name().findRev('_');
    if (mm>0)
    {
      md->setName(md->name().left(mm));
    }
  }
  else if (md->getMemberSpecifiers()==VhdlDocGen::TYPE)
  {
    QCString largs=md->argsString();
    bool bRec=largs.stripPrefix("record") ;
    bool bUnit=largs.stripPrefix("units") ;
    if (bRec || bUnit)
    {
      md->setType("");
    }
  }
}

引用了 MemberDef::argsString(), CONFIG, QCString::findRev(), MemberDef::getMemberSpecifiers(), INSTANTIATION, QCString::left(), LIBRARY, QCString::lower(), MISCELLANEOUS, Definition::name(), MemberDefMutable::setMemberSpecifiers(), DefinitionMutable::setName(), MemberDefMutable::setType(), QCString::stripPrefix(), TYPE, MemberDef::typeString(), UCF_CONST , 以及 USE.

被这些函数引用 vhdlCorrectMemberProperties().

createFlowChart()

void VhdlDocGen::createFlowChart ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2742 行定义.

{
  if (mdef==0) return;
 
  QCString codeFragment;
  const MemberDef* mm=0;
  if ((mm=findMemFlow(mdef))!=0)
  {
    // don't create the same flowchart twice
    VhdlDocGen::setFlowMember(mm);
    return;
  }
  else
  {
    mdList.push_back(mdef);
  }
 
  //fprintf(stderr,"\n create flow mem %s %p\n",qPrint(mdef->name()),mdef);
 
  int actualStart= mdef->getStartBodyLine();
  int actualEnd=mdef->getEndBodyLine();
  const FileDef* fd=mdef->getFileDef();
  bool b=readCodeFragment( fd->absFilePath(), actualStart,actualEnd,codeFragment);
  if (!b) return;
 
  auto parser { Doxygen::parserManager->getOutlineParser(".vhd") };
  VhdlDocGen::setFlowMember(mdef);
  std::shared_ptr<Entry> root = std::make_shared<Entry>();
  StringVector filesInSameTu;
  parser->parseInput("",codeFragment.data(),root,nullptr);
}

引用了 FileDef::absFilePath(), QCString::data(), findMemFlow(), Definition::getEndBodyLine(), MemberDef::getFileDef(), ParserManager::getOutlineParser(), Definition::getStartBodyLine(), mdList, Doxygen::parserManager, readCodeFragment() , 以及 setFlowMember().

被这些函数引用 DocVhdlFlow::parse().

deleteAllChars()

void VhdlDocGen::deleteAllChars ( QCString &  s, char  c  )

static

在文件 vhdldocgen.cpp 第 1085 行定义.

{
  int index=s.findRev(c,-1,FALSE);
  while (index > -1)
  {
    QCString qcs=s.remove(index,1);
    s=qcs;
    index=s.findRev(c,-1,FALSE);
  }
}

引用了 FALSE, QCString::findRev() , 以及 QCString::remove().

被这些函数引用 addBaseClass(), VHDLOutlineParser::createFunction() , 以及 initUCF().

deleteCharRev()

bool VhdlDocGen::deleteCharRev ( QCString &  s, char  c  )

static

deletes a char backwards in a string

在文件 vhdldocgen.cpp 第 1073 行定义.

{
  int index=s.findRev(c,-1,FALSE);
  if (index > -1)
  {
    QCString qcs=s.remove(index,1);
    s=qcs;
    return TRUE;
  }
  return FALSE;
}

引用了 FALSE, QCString::findRev(), QCString::remove() , 以及 TRUE.

被这些函数引用 parseFuncProto().

findAllArchitectures()

void VhdlDocGen::findAllArchitectures ( std::vector< QCString > &  ql, const ClassDef *  cd  )

staticprivate

在文件 vhdldocgen.cpp 第 906 行定义.

{
  for (const auto &citer : *Doxygen::classLinkedMap)
  {
    QCString className=citer->className();
    int pos;
    if (cd != citer.get() && (pos=className.find('-'))!=-1)
    {
      QCString postfix=className.mid(pos+1);
      if (qstricmp(cd->className(),postfix)==0)
      {
        qll.push_back(className);
      }
    }
  }// for
}//findAllArchitectures

引用了 Doxygen::classLinkedMap, ClassDef::className(), QCString::find(), QCString::mid() , 以及 qstricmp().

被这些函数引用 writeInlineClassLink().

findAllPackages()

void VhdlDocGen::findAllPackages ( ClassDef *  cdef )

static

finds all included packages of an Entity or Package

在文件 vhdldocgen.cpp 第 741 行定义.

{
  if (g_packages.find(cdef)!=g_packages.end()) return;
  std::vector<ClassDef*> cList;
  MemberList *mem=cdef->getMemberList(MemberListType_variableMembers);
  if (mem)
  {
    for (const auto &md : *mem)
    {
      if (VhdlDocGen::isPackage(md))
      {
        ClassDef* cd=VhdlDocGen::getPackageName(md->name());
        if (cd)
        {
          cList.push_back(cd);
          VhdlDocGen::findAllPackages(cd);
          g_packages.insert({cdef,cList});
        }
      }
    }//for
  }
 
}// findAllPackages

引用了 g_packages, ClassDef::getMemberList(), getPackageName(), isPackage() , 以及 MemberListType_variableMembers.

被这些函数引用 findMember().

findArchitecture()

const ClassDef * VhdlDocGen::findArchitecture ( const ClassDef *  cd )

static

在文件 vhdldocgen.cpp 第 923 行定义.

{
  QCString nn=cd->name();
  for (const auto &citer : *Doxygen::classLinkedMap)
  {
    QCString jj=citer->name();
    StringVector ql=split(jj.str(),":");
    if (ql.size()>1)
    {
      if (QCString(ql[0])==nn)
      {
        return citer.get();
      }
    }
  }
  return 0;
}

引用了 Doxygen::classLinkedMap, Definition::name(), split() , 以及 QCString::str().

findFunction()

const MemberDef * VhdlDocGen::findFunction ( const QCString &  funcname, const QCString &  package  )

static

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

在文件 vhdldocgen.cpp 第 770 行定义.

{
  ClassDef *cdef=getClass(package);
  if (cdef==0) return 0;
 
  MemberList *mem=cdef->getMemberList(MemberListType_pubMethods);
  if (mem)
  {
    for (const auto &mdef : *mem)
    {
      QCString mname=mdef->name();
      if ((VhdlDocGen::isProcedure(mdef) || VhdlDocGen::isVhdlFunction(mdef)) && (compareString(funcname,mname)==0))
      {
        return mdef;
      }//if
    }//for
  }//if
  return 0;
} //findFunction

引用了 compareString(), getClass(), ClassDef::getMemberList(), isProcedure(), isVhdlFunction() , 以及 MemberListType_pubMethods.

findKeyWord()

const char * VhdlDocGen::findKeyWord ( const QCString &  kw )

static

returns the color of a keyword

在文件 vhdldocgen.cpp 第 562 行定义.

{
  std::string word=kw.lower().str();
 
  if (word.empty()) return 0;
 
  if (g_vhdlKeyWordSet0.find(word)!=g_vhdlKeyWordSet0.end())
    return "keywordflow";
 
  if (g_vhdlKeyWordSet1.find(word)!=g_vhdlKeyWordSet1.end())
    return "keywordtype";
 
  if (g_vhdlKeyWordSet2.find(word)!=g_vhdlKeyWordSet2.end())
    return "vhdllogic";
 
  if (g_vhdlKeyWordSet3.find(word)!=g_vhdlKeyWordSet3.end())
    return "vhdlkeyword";
 
  return 0;
}

引用了 g_vhdlKeyWordSet0, g_vhdlKeyWordSet1, g_vhdlKeyWordSet2, g_vhdlKeyWordSet3, QCString::lower() , 以及 QCString::str().

被这些函数引用 writeFormatString(), writeFunctionProto() , 以及 writeProcedureProto().

findMember()

const MemberDef * VhdlDocGen::findMember ( const QCString &  className, const QCString &  memName  )

static

在文件 vhdldocgen.cpp 第 598 行定义.

{
  ClassDef* cd,*ecd=0;
  const MemberDef *mdef=0;
 
  cd=getClass(className);
  //printf("VhdlDocGen::findMember(%s,%s)=%p\n",qPrint(className),qPrint(memName),cd);
  if (cd==0) return 0;
 
  mdef=VhdlDocGen::findMemberDef(cd,memName,MemberListType_variableMembers);
  if (mdef) return mdef;
  mdef=VhdlDocGen::findMemberDef(cd,memName,MemberListType_pubMethods);
  if (mdef) return mdef;
 
  // nothing found so far
  // if we are an architecture or package body search in entity
 
  if ((VhdlDocGen::VhdlClasses)cd->protection()==VhdlDocGen::ARCHITECTURECLASS ||
      (VhdlDocGen::VhdlClasses)cd->protection()==VhdlDocGen::PACKBODYCLASS)
  {
    Definition *d = cd->getOuterScope();
    // searching upper/lower case names
 
    QCString tt=d->name();
    ecd =getClass(tt);
    if (!ecd)
    {
      tt=tt.upper();
      ecd =getClass(tt);
    }
    if (!ecd)
    {
      tt=tt.lower();
      ecd =getClass(tt);
    }
 
    if (ecd) //d && d->definitionType()==Definition::TypeClass)
    {
      //ClassDef *ecd = (ClassDef*)d;
      mdef=VhdlDocGen::findMemberDef(ecd,memName,MemberListType_variableMembers);
      if (mdef) return mdef;
      mdef=VhdlDocGen::findMemberDef(cd,memName,MemberListType_pubMethods);
      if (mdef) return mdef;
    }
   }
 
 
  if ((VhdlDocGen::VhdlClasses)cd->protection()==VhdlDocGen::ARCHITECTURECLASS ||
      (VhdlDocGen::VhdlClasses)cd->protection()==VhdlDocGen::PACKBODYCLASS)
  {
    Definition *d = cd->getOuterScope();
 
    QCString tt=d->name();
    ClassDef *acd =getClass(tt);
    if (!acd)
    {
      tt=tt.upper();
      acd =getClass(tt);
    }
    if (!acd)
    {
      tt=tt.lower();
      acd =getClass(tt);
    }
    if (acd) //d && d->definitionType()==Definition::TypeClass)
    {
      if(g_packages.find(acd)==g_packages.end())
      {
        VhdlDocGen::findAllPackages(acd);
      }
    }
  }
  else
  {
    ecd=cd;
    if (g_packages.find(ecd)==g_packages.end()) VhdlDocGen::findAllPackages(ecd);
  }
 
  if (ecd)
  {
    auto cList_it = g_packages.find(ecd);
    if (cList_it!=g_packages.end())
    {
      for (const auto &cdp : cList_it->second)
      {
        mdef=VhdlDocGen::findMemberDef(cdp,memName,MemberListType_variableMembers);
        if (mdef) return mdef;
        mdef=VhdlDocGen::findMemberDef(cdp,memName,MemberListType_pubMethods);
        if (mdef) return mdef;
      }
    }
  }
  return 0;
 
}//findMember

引用了 ARCHITECTURECLASS, findAllPackages(), findMemberDef(), g_packages, getClass(), Definition::getOuterScope(), QCString::lower(), MemberListType_pubMethods, MemberListType_variableMembers, Definition::name(), PACKBODYCLASS, ClassDef::protection() , 以及 QCString::upper().

被这些函数引用 writeStringLink() , 以及 writeVHDLTypeDocumentation().

findMemberDef()

const MemberDef * VhdlDocGen::findMemberDef ( ClassDef *  cd, const QCString &  key, MemberListType  type  )

static

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

在文件 vhdldocgen.cpp 第 698 行定义.

{
  QCString keyType=cd->symbolName()+"@"+key;
  //printf("\n %s | %s | %s",qPrint(cd->symbolName()),key.data(,),qPrint(keyType));
 
  auto it = g_varMap.find(keyType.str());
  if (it!=g_varMap.end())
  {
    return it->second;
  }
  if (std::find(g_classList.begin(),g_classList.end(),cd)!=g_classList.end())
  {
    return 0;
  }
  const MemberList *ml=cd->getMemberList(type);
  g_classList.push_back(cd);
  if (!ml)
  {
    return 0;
  }
  //int l=ml->count();
  //    fprintf(stderr,"\n loading entity %s %s: %d",qPrint(cd->symbolName()),qPrint(keyType),l);
 
  for (const auto &md : *ml)
  {
    QCString tkey=cd->symbolName()+"@"+md->name();
    if (g_varMap.find(tkey.str())==g_varMap.end())
    {
      g_varMap.insert({tkey.str(),md});
    }
  }
  it=g_varMap.find(keyType.str());
  if (it!=g_varMap.end())
  {
    return it->second;
  }
  return 0;
}//findMemberDef

引用了 g_classList, g_varMap, ClassDef::getMemberList(), QCString::str() , 以及 Definition::symbolName().

被这些函数引用 findMember().

findVhdlClass()

ClassDef * VhdlDocGen::findVhdlClass ( const QCString &  className )

static

在文件 vhdldocgen.cpp 第 2475 行定义.

{
 for (const auto &cd : *Doxygen::classLinkedMap)
 {
   if (qstricmp(className.data(),qPrint(cd->name()))==0)
   {
     return cd.get();
   }
 }
 return 0;
}

引用了 Doxygen::classLinkedMap, QCString::data(), qPrint() , 以及 qstricmp().

被这些函数引用 computeVhdlComponentRelations().

formatString()

void VhdlDocGen::formatString ( const QCString &  s, OutputList &  ol, const MemberDef *  mdef  )

static

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

在文件 vhdldocgen.cpp 第 1210 行定义.

{
  QCString qcs = s;
  QCString temp;
  qcs.stripPrefix(":");
  qcs.stripPrefix("is");
  qcs.stripPrefix("IS");
  qcs.stripPrefix("of");
  qcs.stripPrefix("OF");
 
  // VhdlDocGen::deleteCharRev(qcs,';');
  //char white='\t';
  int len = qcs.length();
  unsigned int index=1;//temp.length();
 
  for (int j=0;j<len;j++)
  {
    char c=qcs[j];
    char b=c;
    if (j>0) b=qcs[j-1];
    if (c=='"' || c==',' || c=='\''|| c=='(' || c==')'  || c==':' || c=='[' || c==']' ) // || (c==':' && b!='=')) // || (c=='=' && b!='>'))
    {
      if (temp.length()>=index && temp.at(index-1) != ' ')
      {
        temp+=" ";
      }
      temp+=c;
      temp+=" ";
    }
    else if (c=='=')
    {
      if (b==':') // := operator
      {
        temp.replace(index-1,1,"=");
        temp+=" ";
      }
      else // = operator
      {
        temp+=" ";
        temp+=c;
        temp+=" ";
      }
    }
    else
    {
      temp+=c;
    }
 
    index=temp.length();
  }// for
  temp=temp.stripWhiteSpace();
  // printf("\n [%s]",qPrint(qcs));
  VhdlDocGen::writeFormatString(temp,ol,mdef);
}

引用了 QCString::at(), QCString::length(), QCString::replace(), QCString::stripPrefix(), QCString::stripWhiteSpace() , 以及 writeFormatString().

被这些函数引用 writeFunctionProto(), writeProcedureProto(), writeRecordUnit(), writeRecUnitDocu(), writeUCFLink(), writeVHDLDeclaration() , 以及 writeVHDLTypeDocumentation().

getClass()

ClassDef * VhdlDocGen::getClass ( const QCString &  name )

static

在文件 vhdldocgen.cpp 第 583 行定义.

{
  if (name.isEmpty()) return 0;
  return Doxygen::classLinkedMap->find(QCString(name).stripWhiteSpace());
}

引用了 Doxygen::classLinkedMap, LinkedMap< T, Hash, KeyEqual, Map >::find() , 以及 QCString::isEmpty().

被这些函数引用 findFunction(), findMember(), getPackageName(), writeInlineClassLink() , 以及 writeVHDLDeclaration().

getClassName()

QCString VhdlDocGen::getClassName ( const ClassDef *  cd )

static

在文件 vhdldocgen.cpp 第 810 行定义.

{
  QCString temp;
  if (cd==0) return "";
 
  if ((VhdlDocGen::VhdlClasses)cd->protection()==VhdlDocGen::PACKBODYCLASS)
  {
    temp=cd->name();
    temp.stripPrefix("_");
    return temp;
  }
 
  return substitute(cd->className(),"::",".");
}

引用了 ClassDef::className(), Definition::name(), PACKBODYCLASS, ClassDef::protection(), QCString::stripPrefix() , 以及 substitute().

被这些函数引用 getClassTitle(), makeDisplayName() , 以及 writeClassType().

getClassTitle()

QCString VhdlDocGen::getClassTitle ( const ClassDef *  cd )

static

returns the class title+ref

在文件 vhdldocgen.cpp 第 797 行定义.

{
  QCString pageTitle;
  if (cd==0) return "";
  pageTitle=VhdlDocGen::getClassName(cd);
  int ii=cd->protection();
  pageTitle+=" ";
  pageTitle+=theTranslator_vhdlType(ii+2,TRUE);
  return pageTitle;
} // getClassTitle

引用了 getClassName(), ClassDef::protection(), theTranslator_vhdlType , 以及 TRUE.

被这些函数引用 ClassDefImpl::title().

getFlowMember()

const MemberDef * VhdlDocGen::getFlowMember ( )

static

在文件 vhdldocgen.cpp 第 92 行定义.

{
  return flowMember;
}

引用了 flowMember.

被这些函数引用 FlowChart::addFlowChart(), VHDLOutlineParser::addVhdlType(), FlowChart::alignFuncProc(), FlowChart::convertNameToFileName(), VHDLOutlineParser::createFlow(), VHDLOutlineParser::handleFlowComment(), FlowChart::moveToPrevLevel(), HtmlDocVisitor::visitPost() , 以及 HtmlDocVisitor::visitPre().

getIndexWord()

QCString VhdlDocGen::getIndexWord ( const QCString &  c, int  index  )

static

在文件 vhdldocgen.cpp 第 1041 行定义.

{
  static const reg::Ex reg(R"([\s|])");
  auto ql=split(c.str(),reg);
 
  if ((size_t)index < ql.size())
  {
    return QCString(ql[index]);
  }
 
  return "";
}

引用了 split() , 以及 QCString::str().

被这些函数引用 computeVhdlComponentRelations() , 以及 parseFuncProto().

getPackageName()

ClassDef * VhdlDocGen::getPackageName ( const QCString &  name )

static

在文件 vhdldocgen.cpp 第 589 行定义.

{
  return getClass(name);
}

引用了 getClass().

被这些函数引用 findAllPackages().

getProcessNumber()

QCString VhdlDocGen::getProcessNumber ( )

static

returns the next number of an anonymous process

在文件 vhdldocgen.cpp 第 1115 行定义.

{
  static int stringCounter;
  char buf[8];
  QCString qcs("PROCESS_");
  sprintf(buf,"%d",stringCounter++);
  qcs.append(&buf[0]);
  return qcs;
}

引用了 QCString::append().

getProtectionName()

QCString VhdlDocGen::getProtectionName ( int  prot )

static

在文件 vhdldocgen.cpp 第 1055 行定义.

{
  if (prot==VhdlDocGen::ENTITYCLASS)
    return "entity";
  else if (prot==VhdlDocGen::ARCHITECTURECLASS)
    return "architecture";
  else if (prot==VhdlDocGen::PACKAGECLASS)
    return "package";
  else if (prot==VhdlDocGen::PACKBODYCLASS)
    return "package body";
 
  return "";
}

引用了 ARCHITECTURECLASS, ENTITYCLASS, PACKAGECLASS , 以及 PACKBODYCLASS.

被这些函数引用 writeAnnotatedClassList() , 以及 ClassDefImpl::writeDeclarationLink().

getRecordNumber()

QCString VhdlDocGen::getRecordNumber ( )

static

returns the next number of a record|unit member

在文件 vhdldocgen.cpp 第 1103 行定义.

{
  char buf[12];
  sprintf(buf,"%d",recordCounter++);
  QCString qcs(&buf[0]);
  return qcs;
}

引用了 recordCounter.

被这些函数引用 VHDLOutlineParser::checkInlineCode(), initUCF() , 以及 writeVhdlEntityToolTip().

init()

void VhdlDocGen::init ( )

static

在文件 vhdldocgen.cpp 第 555 行定义.

{
}

isAlias()

bool VhdlDocGen::isAlias ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2785 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::ALIAS; }

引用了 ALIAS , 以及 MemberDef::getMemberSpecifiers().

被这些函数引用 writeTagFile().

isArchitecture()

bool VhdlDocGen::isArchitecture ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2819 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::ARCHITECTURE; }

引用了 ARCHITECTURE , 以及 MemberDef::getMemberSpecifiers().

isAttribute()

bool VhdlDocGen::isAttribute ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2811 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::ATTRIBUTE; }

引用了 ATTRIBUTE , 以及 MemberDef::getMemberSpecifiers().

被这些函数引用 writeTagFile().

isCompInst()

bool VhdlDocGen::isCompInst ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2831 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::INSTANTIATION; }

引用了 MemberDef::getMemberSpecifiers() , 以及 INSTANTIATION.

被这些函数引用 writeTagFile() , 以及 writeVHDLDeclaration().

isComponent()

bool VhdlDocGen::isComponent ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2793 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::COMPONENT; }

引用了 COMPONENT , 以及 MemberDef::getMemberSpecifiers().

被这些函数引用 writeTagFile() , 以及 writeVHDLDeclaration().

isConfig()

bool VhdlDocGen::isConfig ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2783 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::CONFIG; }

引用了 CONFIG , 以及 MemberDef::getMemberSpecifiers().

被这些函数引用 writeVHDLDeclaration().

isConstant()

bool VhdlDocGen::isConstant ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2799 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::CONSTANT; }

引用了 CONSTANT , 以及 MemberDef::getMemberSpecifiers().

被这些函数引用 writeTagFile().

isConstraint()

bool VhdlDocGen::isConstraint ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2781 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::UCF_CONST; }

引用了 MemberDef::getMemberSpecifiers() , 以及 UCF_CONST.

被这些函数引用 writeVHDLTypeDocumentation().

isEntity()

bool VhdlDocGen::isEntity ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2797 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::ENTITY; }

引用了 ENTITY , 以及 MemberDef::getMemberSpecifiers().

被这些函数引用 writeTagFile().

isFile()

bool VhdlDocGen::isFile ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2827 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::VFILE; }

引用了 MemberDef::getMemberSpecifiers() , 以及 VFILE.

被这些函数引用 writeTagFile().

isGeneric()

bool VhdlDocGen::isGeneric ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2789 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::GENERIC; }

引用了 GENERIC , 以及 MemberDef::getMemberSpecifiers().

被这些函数引用 writeTagFile() , 以及 writeVHDLTypeDocumentation().

isGroup()

bool VhdlDocGen::isGroup ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2829 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::GROUP; }

引用了 MemberDef::getMemberSpecifiers() , 以及 GROUP.

被这些函数引用 writeTagFile().

isLibrary()

bool VhdlDocGen::isLibrary ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2787 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::LIBRARY; }

引用了 MemberDef::getMemberSpecifiers() , 以及 LIBRARY.

被这些函数引用 writeTagFile() , 以及 writeVHDLTypeDocumentation().

isMisc()

bool VhdlDocGen::isMisc ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2833 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::MISCELLANEOUS; }

引用了 MemberDef::getMemberSpecifiers() , 以及 MISCELLANEOUS.

被这些函数引用 MemberDefImpl::writeDocumentation().

isNumber()

bool VhdlDocGen::isNumber ( const std::string &  s )

static

returns TRUE if this string is a number

在文件 vhdldocgen.cpp 第 1198 行定义.

{
  static const reg::Ex regg(R"([0-9][0-9eEfFbBcCdDaA_.#+?xXzZ-]*)");
  return reg::match(s,regg);
}// isNumber

引用了 reg::match().

被这些函数引用 writeFormatString().

isPackage()

bool VhdlDocGen::isPackage ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2795 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::USE; }

引用了 MemberDef::getMemberSpecifiers() , 以及 USE.

被这些函数引用 findAllPackages(), writeTagFile() , 以及 writeVHDLTypeDocumentation().

isPackageBody()

bool VhdlDocGen::isPackageBody ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2823 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::PACKAGE_BODY; }

引用了 MemberDef::getMemberSpecifiers() , 以及 PACKAGE_BODY.

isPort()

bool VhdlDocGen::isPort ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2791 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::PORT; }

引用了 MemberDef::getMemberSpecifiers() , 以及 PORT.

被这些函数引用 writeTagFile() , 以及 writeVHDLTypeDocumentation().

isProcedure()

bool VhdlDocGen::isProcedure ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2815 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::PROCEDURE; }

引用了 MemberDef::getMemberSpecifiers() , 以及 PROCEDURE.

被这些函数引用 findFunction(), writeFuncProcDocu(), writeTagFile() , 以及 writeVHDLTypeDocumentation().

isProcess()

bool VhdlDocGen::isProcess ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2807 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::PROCESS; }

引用了 MemberDef::getMemberSpecifiers() , 以及 PROCESS.

被这些函数引用 writeFuncProcDocu(), writeTagFile() , 以及 writeVHDLTypeDocumentation().

isRecord()

bool VhdlDocGen::isRecord ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2817 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::RECORD; }

引用了 MemberDef::getMemberSpecifiers() , 以及 RECORD.

被这些函数引用 writeTagFile().

isSignal()

bool VhdlDocGen::isSignal ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2809 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::SIGNAL; }

引用了 MemberDef::getMemberSpecifiers() , 以及 SIGNAL.

isSignals()

bool VhdlDocGen::isSignals ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2813 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::SIGNAL; }

引用了 MemberDef::getMemberSpecifiers() , 以及 SIGNAL.

被这些函数引用 writeTagFile().

isSubClass()

bool VhdlDocGen::isSubClass ( ClassDef *  cd, ClassDef *  scd, bool  followInstances, int  level  )

static

在文件 vhdldocgen.cpp 第 2665 行定义.

{
  bool found=FALSE;
  //printf("isBaseClass(cd=%s) looking for %s\n",qPrint(name()),qPrint(bcd->name()));
  if (level>255)
  {
    err("Possible recursive class relation while inside %s and looking for %s\n",qPrint(cd->name()),qPrint(scd->name()));
    abort();
    return FALSE;
  }
 
  for (const auto &bcd :cd->subClasses())
  {
    const ClassDef *ccd=bcd.classDef;
    if (!followInstances && ccd->templateMaster()) ccd=ccd->templateMaster();
    //printf("isSubClass() subclass %s\n",qPrint(ccd->name()));
    if (ccd==scd)
    {
      found=TRUE;
    }
    else
    {
      if (level <256)
      {
        found=ccd->isBaseClass(scd,followInstances,level+1);
      }
    }
  }
  return found;
}

引用了 err(), FALSE, ClassDef::isBaseClass(), Definition::name(), qPrint(), ClassDef::subClasses(), ClassDef::templateMaster() , 以及 TRUE.

被这些函数引用 addInstance().

isSubType()

bool VhdlDocGen::isSubType ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2803 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::SUBTYPE; }

引用了 MemberDef::getMemberSpecifiers() , 以及 SUBTYPE.

被这些函数引用 writeTagFile().

isUnit()

bool VhdlDocGen::isUnit ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2821 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::UNITS; }

引用了 MemberDef::getMemberSpecifiers() , 以及 UNITS.

isVariable()

bool VhdlDocGen::isVariable ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2825 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::SHAREDVARIABLE; }

引用了 MemberDef::getMemberSpecifiers() , 以及 SHAREDVARIABLE.

被这些函数引用 writeTagFile().

isVhdlClass()

static bool VhdlDocGen::isVhdlClass ( const Entry *  cu )

inlinestatic

在文件 vhdldocgen.h 第 236 行定义.

    {
      return cu->spec==VhdlDocGen::ENTITY       ||
             cu->spec==VhdlDocGen::PACKAGE      ||
             cu->spec==VhdlDocGen::ARCHITECTURE ||
             cu->spec==VhdlDocGen::PACKAGE_BODY;
    }

引用了 ARCHITECTURE, ENTITY, PACKAGE, PACKAGE_BODY , 以及 Entry::spec.

被这些函数引用 VHDLOutlineParser::mapLibPackage().

isVhdlFunction()

bool VhdlDocGen::isVhdlFunction ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2805 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::FUNCTION; }

引用了 FUNCTION , 以及 MemberDef::getMemberSpecifiers().

被这些函数引用 findFunction(), writeFuncProcDocu(), writeTagFile() , 以及 writeVHDLTypeDocumentation().

isVType()

bool VhdlDocGen::isVType ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2801 行定义.

{ return mdef->getMemberSpecifiers()==VhdlDocGen::TYPE; }

引用了 MemberDef::getMemberSpecifiers() , 以及 TYPE.

被这些函数引用 writeTagFile().

parseForBinding()

QCString VhdlDocGen::parseForBinding ( QCString &  entity, QCString &  arch  )

static

在文件 vhdldocgen.cpp 第 2441 行定义.

{
  static const reg::Ex exp(R"([()\s])");
 
  auto ql = split(entity.str(),exp);
 
  if (findIndex(ql,"open")!=-1)
  {
    return "open";
  }
 
  if (ql.size()<2)
  {
    return "";
  }
 
  std::string label=ql[0];
  entity = ql[1];
  int index;
  if ((index=entity.findRev("."))>=0)
  {
    entity.remove(0,index+1);
  }
 
  if (ql.size()==3)
  {
    arch=ql[2];
  }
  return QCString(label);
}

引用了 findIndex(), QCString::findRev(), QCString::remove(), split() , 以及 QCString::str().

被这些函数引用 computeVhdlComponentRelations().

parseForConfig()

QCString VhdlDocGen::parseForConfig ( QCString &  entity, QCString &  arch  )

static

在文件 vhdldocgen.cpp 第 2408 行定义.

{
  QCString label;
  if (!entity.contains(":")) return "";
 
  static const reg::Ex exp(R"([:()\s])");
  auto ql=split(entity.str(),exp);
  if (ql.size()<2)
  {
    return "";
  }
  label  = ql[0];
  entity = ql[1];
  int index;
  if ((index=entity.findRev("."))>=0)
  {
    entity.remove(0,index+1);
  }
 
  if (ql.size()==3)
  {
    arch = ql[2];
    ql=split(arch.str(),exp);
    if (ql.size()>1) // expression
    {
      arch="";
    }
  }
  return label; // label
}

引用了 QCString::contains(), QCString::findRev(), QCString::remove(), split() , 以及 QCString::str().

parseFuncProto()

void VhdlDocGen::parseFuncProto ( const QCString &  text, QCString &  name, QCString &  ret, bool  doc = false  )

static

parses a function proto

参数

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

在文件 vhdldocgen.cpp 第 990 行定义.

{
  int index,end;
  QCString s1(text);
  QCString temp;
 
  index=s1.find("(");
  if (index<0) index=0;
  end=s1.findRev(")");
 
  if ((end-index)>0)
  {
    temp=s1.mid(index+1,(end-index-1));
    //getFuncParams(qlist,temp);
  }
  if (doc)
  {
    name=s1.left(index);
    name=name.stripWhiteSpace();
    if ((end-index)>0)
    {
      ret="function";
    }
    return;
  }
  else
  {
    s1=s1.stripWhiteSpace();
    int i=s1.find('(');
    int s=s1.find(' ');
    if (s==-1) s=s1.find('\t');
    if (i==-1 || i<s)
      s1=VhdlDocGen::getIndexWord(s1,1);
    else // s<i, s=start of name, i=end of name
      s1=s1.mid(s,(i-s));
 
    name=s1.stripWhiteSpace();
  }
  index=s1.findRev("return",-1,FALSE);
  if (index !=-1)
  {
    ret=s1.mid(index+6,s1.length());
    ret=ret.stripWhiteSpace();
    VhdlDocGen::deleteCharRev(ret,';');
  }
}

引用了 deleteCharRev(), end(), FALSE, QCString::find(), QCString::findRev(), getIndexWord(), QCString::left(), QCString::length(), QCString::mid() , 以及 QCString::stripWhiteSpace().

parseUCF()

void VhdlDocGen::parseUCF ( const char *  input, Entry *  entity, const QCString &  f, bool  vendor  )

static

在文件 vhdldocgen.cpp 第 2266 行定义.

{
  QCString ucFile(input);
  int lineNo=0;
  QCString comment("#!");
  QCString brief;
 
  while (!ucFile.isEmpty())
  {
    int i=ucFile.find("\n");
    if (i<0) break;
    lineNo++;
    QCString temp=ucFile.left(i);
    temp=temp.stripWhiteSpace();
    bool bb=temp.stripPrefix("//");
 
    if (!temp.isEmpty())
    {
      if (temp.stripPrefix(comment) )
      {
        brief+=temp;
        brief.append("\\n");
      }
      else if (!temp.stripPrefix("#") && !bb)
      {
        if (altera)
        {
          int in=temp.find("-name");
          if (in>0)
          {
            temp=temp.remove(0,in+5);
          }
 
          temp.stripPrefix("set_location_assignment");
 
          initUCF(entity,QCString(),temp,lineNo,fileName,brief);
        }
        else
        {
          static const reg::Ex ee(R"([\s=])");
          int in=findIndex(temp.str(),ee);
          if (in<0) in=0;
          QCString ff=temp.left(in);
          temp.stripPrefix(ff);
          ff.append("#");
          if (!temp.isEmpty())
          {
            initUCF(entity,ff,temp,lineNo,fileName,brief);
          }
        }
      }
    }//temp
 
    ucFile=ucFile.remove(0,i+1);
  }// while
}

引用了 QCString::append(), comment, QCString::find(), findIndex(), initUCF(), QCString::isEmpty(), QCString::left(), QCString::remove(), QCString::str(), QCString::stripPrefix() , 以及 QCString::stripWhiteSpace().

被这些函数引用 VHDLOutlineParser::parseInput().

prepareComment()

void VhdlDocGen::prepareComment ( QCString &  qcs )

static

strips the "--" prefixes of vhdl comments

在文件 vhdldocgen.cpp 第 968 行定义.

{
  const char* s="--!";
  int index=0;
 
  while (TRUE)
  {
    index=qcs.find(s,0,TRUE);
    if (index<0) break;
    qcs=qcs.remove(index,qstrlen(s));
  }
  qcs=qcs.stripWhiteSpace();
}

引用了 QCString::find(), qstrlen(), QCString::remove(), QCString::stripWhiteSpace() , 以及 TRUE.

被这些函数引用 VHDLOutlineParser::checkInlineCode(), VHDLOutlineParser::checkMultiComment() , 以及 VHDLOutlineParser::handleCommentBlock().

resetCodeVhdlParserState()

void VhdlDocGen::resetCodeVhdlParserState ( )

static

在文件 vhdldocgen.cpp 第 2774 行定义.

{
  g_varMap.clear();
  g_classList.clear();
  g_packages.clear();
}

引用了 g_classList, g_packages , 以及 g_varMap.

setFlowMember()

void VhdlDocGen::setFlowMember ( const MemberDef *  flowMember )

static

在文件 vhdldocgen.cpp 第 87 行定义.

{
  flowMember=mem;
}

引用了 flowMember.

被这些函数引用 createFlowChart().

writeClassType()

bool VhdlDocGen::writeClassType ( const ClassDef *  cd, OutputList &  ol, QCString &  cname  )

static

在文件 vhdldocgen.cpp 第 2150 行定义.

{
  int id=cd->protection();
  QCString qcs = theTranslator->trVhdlType(id+2,TRUE);
  cname=VhdlDocGen::getClassName(cd);
  ol.startBold();
  ol.writeString(qcs);
  ol.writeString(" ");
  ol.endBold();
  //ol.insertMemberAlign();
  return FALSE;
}// writeClassLink

引用了 OutputList::endBold(), FALSE, getClassName(), ClassDef::protection(), OutputList::startBold(), theTranslator, TRUE, Translator::trVhdlType() , 以及 OutputList::writeString().

writeFormatString()

void VhdlDocGen::writeFormatString ( const QCString &  s, OutputList &  ol, const MemberDef *  mdef  )

static

writes a colored and formatted string

在文件 vhdldocgen.cpp 第 1129 行定义.

{
  static const reg::Ex reg(R"([\[\]./<>:\s,;'+*|&=()\"-])");
  QCString qcs = s;
  qcs+=QCString(" ");// parsing the last sign
  QCString find=qcs;
  QCString temp=qcs;
  char buf[2];
  buf[1]='\0';
 
  int j = findIndex(temp.str(),reg);
 
  ol.startBold();
  if (j>=0)
  {
    while (j>=0)
    {
      find=find.left(j);
      buf[0]=temp[j];
      const char *ss=VhdlDocGen::findKeyWord(find);
      bool k=isNumber(find.str()); // is this a number
      if (k)
      {
        ol.docify(" ");
        startFonts(find,"vhdldigit",ol);
        ol.docify(" ");
      }
      else if (j != 0 && ss)
      {
        startFonts(find,ss,ol);
      }
      else
      {
        if (j>0)
        {
          VhdlDocGen::writeStringLink(mdef,find,ol);
        }
      }
      startFonts(&buf[0],"vhdlchar",ol);
 
      QCString st=temp.remove(0,j+1);
      find=st;
      if (!find.isEmpty() && find.at(0)=='"')
      {
        int ii=find.find('"',2);
        if (ii>1)
        {
          QCString com=find.left(ii+1);
          startFonts(com,"keyword",ol);
          temp=find.remove(0,ii+1);
        }
      }
      else
      {
        temp=st;
      }
      j = findIndex(temp.str(),reg);
    }//while
  }//if
  else
  {
    startFonts(find,"vhdlchar",ol);
  }
  ol.endBold();
}// writeFormatString

引用了 QCString::at(), OutputList::docify(), OutputList::endBold(), QCString::find(), findIndex(), findKeyWord(), QCString::isEmpty(), isNumber(), QCString::left(), QCString::remove(), OutputList::startBold(), startFonts(), QCString::str() , 以及 writeStringLink().

被这些函数引用 formatString(), writeFuncProcDocu() , 以及 writeProcessProto().

writeFuncProcDocu()

bool VhdlDocGen::writeFuncProcDocu ( const MemberDef *  md, OutputList &  ol, const ArgumentList &  al, bool  type = false  )

static

writes a function|procedure documentation to the output

在文件 vhdldocgen.cpp 第 1428 行定义.

{
  //bool sem=FALSE;
  ol.enableAll();
 
  size_t index=al.size();
  if (index==0)
  {
    ol.docify(" ( ) ");
    return FALSE;
  }
  ol.endMemberDocName();
  ol.startParameterList(TRUE);
  //ol.startParameterName(FALSE);
  bool first=TRUE;
  for (const Argument &arg : al)
  {
    ol.startParameterType(first,"");
    //   if (first) ol.writeChar('(');
    QCString attl=arg.defval;
    bool bGen=attl.stripPrefix("gen!");
    if (bGen)
      VhdlDocGen::writeFormatString(QCString("generic "),ol,md);
 
 
    if (VhdlDocGen::isProcedure(md))
    {
      startFonts(arg.defval,"keywordtype",ol);
      ol.docify(" ");
    }
    ol.endParameterType();
 
    ol.startParameterName(TRUE);
    VhdlDocGen::writeFormatString(arg.name,ol,md);
 
    if (VhdlDocGen::isProcedure(md))
    {
      startFonts(arg.attrib,"stringliteral",ol);
    }
    else if (VhdlDocGen::isVhdlFunction(md))
    {
      startFonts(QCString("in"),"stringliteral",ol);
    }
 
    ol.docify(" ");
    ol.disable(OutputGenerator::Man);
    ol.startEmphasis();
    ol.enable(OutputGenerator::Man);
    if (!VhdlDocGen::isProcess(md))
    {
     // startFonts(arg.type,"vhdlkeyword",ol);
                VhdlDocGen::writeFormatString(arg.type,ol,md);
    }
    ol.disable(OutputGenerator::Man);
    ol.endEmphasis();
    ol.enable(OutputGenerator::Man);
 
    if (--index)
    {
      ol.docify(" , ");
    }
    else
    {
      //    ol.docify(" ) ");
      ol.endParameterName(TRUE,FALSE,TRUE);
      break;
    }
    ol.endParameterName(FALSE,FALSE,FALSE);
 
    //sem=TRUE;
    first=FALSE;
  }
  //ol.endParameterList();
  return TRUE;
 
} // writeDocFunProc

引用了 OutputList::disable(), OutputList::docify(), OutputList::enable(), OutputList::enableAll(), OutputList::endEmphasis(), OutputList::endMemberDocName(), OutputList::endParameterName(), OutputList::endParameterType(), FALSE, isProcedure(), isProcess(), isVhdlFunction(), OutputGenerator::Man, ArgumentList::size(), OutputList::startEmphasis(), startFonts(), OutputList::startParameterList(), OutputList::startParameterName(), OutputList::startParameterType(), QCString::stripPrefix(), TRUE , 以及 writeFormatString().

被这些函数引用 writeVHDLTypeDocumentation().

writeFunctionProto()

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

static

writes a function prototype to the output

在文件 vhdldocgen.cpp 第 1324 行定义.

{
  if (!al.hasParameters()) return;
  bool sem=FALSE;
  size_t len=al.size();
  ol.startBold();
  ol.docify(" ( ");
  ol.endBold();
  if (len>2)
  {
    ol.lineBreak();
  }
  for (const Argument &arg : al)
  {
    ol.startBold();
    QCString att=arg.defval;
    bool bGen=att.stripPrefix("gen!");
 
    if (sem && len < 3)
    {
      ol.docify(" , ");
    }
 
    if (bGen)
    {
      VhdlDocGen::formatString(QCString("generic "),ol,mdef);
    }
    if (!att.isEmpty())
    {
      const char *str=VhdlDocGen::findKeyWord(att);
      att+=" ";
      if (str)
        VhdlDocGen::formatString(att,ol,mdef);
      else
        startFonts(att,"vhdlchar",ol);
    }
 
    QCString nn=arg.name;
    nn+=": ";
    QCString ss=arg.type.stripWhiteSpace(); //.lower();
    QCString w=ss.stripWhiteSpace();//.upper();
    startFonts(nn,"vhdlchar",ol);
    startFonts("in ","stringliteral",ol);
    const char *str=VhdlDocGen::findKeyWord(ss);
    if (str)
      VhdlDocGen::formatString(w,ol,mdef);
    else
      startFonts(w,"vhdlchar",ol);
 
    if (!arg.attrib.isEmpty())
      startFonts(arg.attrib,"vhdlchar",ol);
 
    sem=TRUE;
    ol.endBold();
    if (len > 2)
    {
      ol.lineBreak();
    }
  }
  ol.startBold();
  ol.docify(" )");
  QCString exp=mdef->excpString();
  if (!exp.isEmpty())
  {
    ol.insertMemberAlign();
    ol.startBold();
    ol.docify("[ ");
    ol.docify(exp);
    ol.docify(" ]");
    ol.endBold();
  }
  ol.endBold();
}

引用了 OutputList::docify(), OutputList::endBold(), MemberDef::excpString(), FALSE, findKeyWord(), formatString(), ArgumentList::hasParameters(), OutputList::insertMemberAlign(), QCString::isEmpty(), OutputList::lineBreak(), ArgumentList::size(), OutputList::startBold(), startFonts(), QCString::stripPrefix(), QCString::stripWhiteSpace() , 以及 TRUE.

被这些函数引用 writeVHDLDeclaration().

writeInlineClassLink()

void VhdlDocGen::writeInlineClassLink ( const ClassDef *  cd, OutputList &  ol  )

static

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

在文件 vhdldocgen.cpp 第 829 行定义.

{
  std::vector<QCString> ql;
  QCString nn=cd->className();
  int ii=(int)cd->protection()+2;
 
  QCString type;
  if (ii==VhdlDocGen::ENTITY)
    type+=theTranslator_vhdlType(VhdlDocGen::ARCHITECTURE,TRUE);
  else if (ii==VhdlDocGen::ARCHITECTURE)
    type+=theTranslator_vhdlType(VhdlDocGen::ENTITY,TRUE);
  else if (ii==VhdlDocGen::PACKAGE_BODY)
    type+=theTranslator_vhdlType(VhdlDocGen::PACKAGE,TRUE);
  else if (ii==VhdlDocGen::PACKAGE)
    type+=theTranslator_vhdlType(VhdlDocGen::PACKAGE_BODY,TRUE);
  else
    type+="";
 
  //type=type.lower();
  type+=" >> ";
  ol.disable(OutputGenerator::RTF);
  ol.disable(OutputGenerator::Man);
 
  if (ii==VhdlDocGen::PACKAGE_BODY)
  {
    nn.stripPrefix("_");
    cd=getClass(nn);
  }
  else  if (ii==VhdlDocGen::PACKAGE)
  {
    nn.prepend("_");
    cd=getClass(nn);
  }
  else if (ii==VhdlDocGen::ARCHITECTURE)
  {
    StringVector qlist=split(nn.str(),"-");
    if (qlist.size()>1)
    {
      nn=qlist[1];
      cd=VhdlDocGen::getClass(nn);
    }
  }
 
  QCString opp;
  if (ii==VhdlDocGen::ENTITY)
  {
    VhdlDocGen::findAllArchitectures(ql,cd);
    for (const auto &s : ql)
    {
      StringVector qlist=split(s.str(),"-");
      if (qlist.size()>2)
      {
        QCString s1(qlist[0]);
        QCString s2(qlist[1]);
        s1.stripPrefix("_");
        if (ql.size()==1) s1.resize(0);
        ClassDef *cc = getClass(s);
        if (cc)
        {
          VhdlDocGen::writeVhdlLink(cc,ol,type,s2,s1);
        }
      }
    }
  }
  else
  {
    VhdlDocGen::writeVhdlLink(cd,ol,type,nn,opp);
  }
 
  ol.enable(OutputGenerator::Man);
  ol.enable(OutputGenerator::RTF);
 
}// write

引用了 ARCHITECTURE, ClassDef::className(), OutputList::disable(), OutputList::enable(), ENTITY, findAllArchitectures(), getClass(), OutputGenerator::Man, PACKAGE, PACKAGE_BODY, QCString::prepend(), ClassDef::protection(), QCString::resize(), OutputGenerator::RTF, split(), QCString::str(), QCString::stripPrefix(), theTranslator_vhdlType, TRUE , 以及 writeVhdlLink().

被这些函数引用 ClassDefImpl::writeMemberDeclarations().

writeOverview() [1/2]

void VhdlDocGen::writeOverview ( )

static

在文件 vhdldocgen.cpp 第 176 行定义.

{
  bool found=FALSE;
  for (const auto &cd : *Doxygen::classLinkedMap)
  {
    if ((VhdlDocGen::VhdlClasses)cd->protection()==VhdlDocGen::ENTITYCLASS )
    {
      found=TRUE;
      break;
    }
  }
 
  if (!found) return;
 
  QCString ov =Config_getString(HTML_OUTPUT);
  QCString fileName=ov+"/vhdl_design.dot";
  std::ofstream f(fileName.str(),std::ofstream::out | std::ofstream::binary);
  if (!f.is_open())
  {
    err("Warning: Cannot open file %s for writing\n",qPrint(fileName));
    return;
  }
  TextStream t(&f);
 
  startDot(t);
 
  for (const auto &cd : *Doxygen::classLinkedMap)
  {
    if ((VhdlDocGen::VhdlClasses)cd->protection()!=VhdlDocGen::ENTITYCLASS )
    {
      continue;
    }
 
    std::vector<const MemberDef *> ports = getPorts(cd.get());
    if (ports.empty())
    {
      continue;
    }
 
    startTable(t,cd->name());
    writeClassToDot(t,cd.get());
    writeTable(ports,t);
    endTable(t);
 
    writeVhdlEntityToolTip(t,cd.get());
 
    for (const auto &bcd : cd->baseClasses())
    {
      ClassDef *bClass=bcd.classDef;
      QCString dotn=cd->name()+":";
      dotn+=cd->name();
      QCString csc=bClass->name()+":";
      csc+=bClass->name();
      //  fprintf(stderr,"\n <%s| %s>",qPrint(dotn),qPrint(csc));
      writeVhdlDotLink(t,dotn,csc,QCString());
    }
  }// for
 
  endDot(t);
  //  writePortLinks(t);
  t.flush();
  f.close();
  createSVG();
}

引用了 Doxygen::classLinkedMap, Config_getString, createSVG(), endDot(), endTable(), ENTITYCLASS, err(), FALSE, TextStream::flush(), getPorts(), Definition::name(), qPrint(), startDot(), startTable(), QCString::str(), TRUE, writeClassToDot(), writeTable(), writeVhdlDotLink() , 以及 writeVhdlEntityToolTip().

writeOverview() [2/2]

static void VhdlDocGen::writeOverview ( OutputList &  ol )

static

writePlainVHDLDeclarations()

void VhdlDocGen::writePlainVHDLDeclarations ( const MemberList *  ml, OutputList &  ol, const ClassDef *  cd, const NamespaceDef *  nd, const FileDef *  fd, const GroupDef *  gd, uint64_t  specifier  )

static

在文件 vhdldocgen.cpp 第 2045 行定义.

{
 
  StringSet pack;
 
  bool first=TRUE;
  for (const auto &imd : *mlist)
  {
    MemberDefMutable *md = toMemberDefMutable(imd);
    if (md)
    {
      uint64_t mems=md->getMemberSpecifiers();
      if (md->isBriefSectionVisible() && (mems==specifier) && (mems!=VhdlDocGen::LIBRARY) )
      {
        if (first) { ol.startMemberList();first=FALSE; }
        VhdlDocGen::writeVHDLDeclaration(md,ol,cd,nd,fd,gd,FALSE);
      } //if
      else if (md->isBriefSectionVisible() && (mems==specifier))
      {
        if (pack.find(md->name().str())==pack.end())
        {
          if (first) ol.startMemberList(),first=FALSE;
          VhdlDocGen::writeVHDLDeclaration(md,ol,cd,nd,fd,gd,FALSE);
          pack.insert(md->name().str());
        }
      } //if
    } //if
  } //for
  if (!first) ol.endMemberList();
}//plainDeclaration

引用了 OutputList::endMemberList(), FALSE, MemberDef::getMemberSpecifiers(), MemberDef::isBriefSectionVisible(), LIBRARY, Definition::name(), OutputList::startMemberList(), QCString::str(), toMemberDefMutable(), TRUE , 以及 writeVHDLDeclaration().

被这些函数引用 writeVHDLDeclarations().

writeProcedureProto()

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

static

writes a procedure prototype to the output

在文件 vhdldocgen.cpp 第 1269 行定义.

{
  bool sem=FALSE;
  size_t len=al.size();
  ol.docify("( ");
  if (len > 2)
  {
    ol.lineBreak();
  }
  for (const Argument &arg : al)
  {
    ol.startBold();
    if (sem && len <3)
      ol.writeChar(',');
 
    QCString nn=arg.name;
    nn+=": ";
 
    QCString defval = arg.defval;
    const char *str=VhdlDocGen::findKeyWord(defval);
    defval+=" ";
    if (str)
    {
      startFonts(defval,str,ol);
    }
    else
    {
      startFonts(defval,"vhdlchar",ol); // write type (variable,constant etc.)
    }
 
    startFonts(nn,"vhdlchar",ol); // write name
    if (qstricmp(arg.attrib,arg.type) != 0)
    {
      startFonts(arg.attrib.lower(),"stringliteral",ol); // write in|out
    }
    ol.docify(" ");
    VhdlDocGen::formatString(arg.type,ol,mdef);
    sem=TRUE;
    ol.endBold();
    if (len > 2)
    {
      ol.lineBreak();
      ol.docify("  ");
    }
  }//for
 
  ol.docify(" )");
 
 
}

引用了 OutputList::docify(), OutputList::endBold(), FALSE, findKeyWord(), formatString(), OutputList::lineBreak(), qstricmp(), ArgumentList::size(), OutputList::startBold(), startFonts(), TRUE , 以及 OutputList::writeChar().

被这些函数引用 writeVHDLDeclaration().

writeProcessProto()

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

static

writes a process prototype to the output

在文件 vhdldocgen.cpp 第 1402 行定义.

{
  if (!al.hasParameters()) return;
  bool sem=FALSE;
  ol.startBold();
  ol.docify(" ( ");
  for (const Argument &arg : al)
  {
    if (sem)
    {
      ol.docify(" , ");
    }
    QCString nn=arg.name;
    // startFonts(nn,"vhdlchar",ol);
    VhdlDocGen::writeFormatString(nn,ol,mdef);
    sem=TRUE;
  }
  ol.docify(" )");
  ol.endBold();
}

引用了 OutputList::docify(), OutputList::endBold(), FALSE, ArgumentList::hasParameters(), OutputList::startBold(), TRUE , 以及 writeFormatString().

被这些函数引用 writeVHDLDeclaration().

writeRecordProto()

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

static

writeRecordUnit()

void VhdlDocGen::writeRecordUnit ( QCString &  largs, QCString &  ltype, OutputList &  ol, const MemberDefMutable *  mdef  )

staticprivate

在文件 vhdldocgen.cpp 第 2612 行定义.

{
  int i=mdef->name().find('~');
  if (i>0)
  {
    //sets the real record member name
    const_cast<MemberDefMutable*>(mdef)->setName(mdef->name().left(i));
  }
 
  writeLink(mdef,ol);
  ol.startBold();
  ol.insertMemberAlign();
  if (!ltype.isEmpty()){
    VhdlDocGen::formatString(ltype,ol,mdef);
  }
  ol.endBold();
}

引用了 OutputList::endBold(), QCString::find(), formatString(), OutputList::insertMemberAlign(), QCString::isEmpty(), QCString::left(), Definition::name(), OutputList::startBold() , 以及 writeLink().

被这些函数引用 writeVHDLDeclaration().

writeRecUnitDocu()

void VhdlDocGen::writeRecUnitDocu ( const MemberDef *  md, OutputList &  ol, QCString  largs  )

staticprivate

在文件 vhdldocgen.cpp 第 2631 行定义.

{
 
  StringVector ql=split(largs.str(),"#");
  size_t len=ql.size();
  ol.startParameterList(TRUE);
  bool first=TRUE;
 
  for(size_t i=0;i<len;i++)
  {
    QCString n=QCString(ql[i]);
    ol.startParameterType(first,"");
    ol.endParameterType();
    ol.startParameterName(TRUE);
    VhdlDocGen::formatString(n,ol,md);
    if ((len-i)>1)
    {
      ol.endParameterName(FALSE,FALSE,FALSE);
    }
    else
    {
      ol.endParameterName(TRUE,FALSE,TRUE);
    }
 
    first=FALSE;
  }
 
}//#

引用了 OutputList::endParameterName(), OutputList::endParameterType(), FALSE, formatString(), split(), OutputList::startParameterList(), OutputList::startParameterName(), OutputList::startParameterType(), QCString::str() , 以及 TRUE.

被这些函数引用 writeVHDLTypeDocumentation().

writeSource()

void VhdlDocGen::writeSource ( const MemberDefMutable *  mdef, OutputList &  ol, const QCString &  cname  )

static

在文件 vhdldocgen.cpp 第 2191 行定义.

{
  auto intf = Doxygen::parserManager->getCodeParser(".vhd");
 // pIntf->resetCodeParserState();
 
  QCString codeFragment=mdef->documentation();
 
  if (cname.isEmpty())
  {
    writeLink(mdef,ol);
    int fi=0;
    int j=0;
    do
    {
     fi=codeFragment.find("\n",++fi);
    } while(fi>=0 && j++ <3);
 
    // show only the first four lines
    if (j==4)
    {
      codeFragment=codeFragment.left(fi);
      codeFragment.append("\n    ....    ");
    }
  }
 
  codeFragment.prepend("\n");
  ol.pushGeneratorState();
  ol.startCodeFragment("DoxyCode");
  intf->parseCode(     ol,               // codeOutIntf
                       QCString(),                // scope
                       codeFragment,     // input
                       SrcLangExt_VHDL,  // lang
                       FALSE,            // isExample
                       QCString(),               // exampleName
                       const_cast<FileDef*>(mdef->getFileDef()), // fileDef
                       mdef->getStartBodyLine(),      // startLine
                       mdef->getEndBodyLine(),        // endLine
                       TRUE,             // inlineFragment
                       mdef,             // memberDef
                       TRUE              // show line numbers
                      );
 
  ol.endCodeFragment("DoxyCode");
  ol.popGeneratorState();
 
  if (cname.isEmpty()) return;
 
  mdef->writeSourceDef(ol,cname);
  if (mdef->hasReferencesRelation()) mdef->writeSourceRefs(ol,cname);
  if (mdef->hasReferencedByRelation()) mdef->writeSourceReffedBy(ol,cname);
}

引用了 QCString::append(), MemberDef::documentation(), OutputList::endCodeFragment(), FALSE, QCString::find(), ParserManager::getCodeParser(), Definition::getEndBodyLine(), MemberDef::getFileDef(), Definition::getStartBodyLine(), MemberDef::hasReferencedByRelation(), MemberDef::hasReferencesRelation(), QCString::isEmpty(), QCString::left(), Doxygen::parserManager, OutputList::popGeneratorState(), QCString::prepend(), OutputList::pushGeneratorState(), SrcLangExt_VHDL, OutputList::startCodeFragment(), TRUE, writeLink(), DefinitionMutable::writeSourceDef(), DefinitionMutable::writeSourceReffedBy() , 以及 DefinitionMutable::writeSourceRefs().

被这些函数引用 MemberDefImpl::writeDocumentation() , 以及 writeVHDLDeclaration().

writeStringLink()

void VhdlDocGen::writeStringLink ( const MemberDef *  mdef, QCString  mem, OutputList &  ol  )

staticprivate

writes a link if the string is linkable else a formatted string

在文件 vhdldocgen.cpp 第 2167 行定义.

{
  if (mdef)
  {
    const ClassDef *cd=mdef->getClassDef();
    if (cd)
    {
      QCString n=cd->name();
      const MemberDef* memdef=VhdlDocGen::findMember(n,mem);
      if (memdef && memdef->isLinkable())
      {
        ol.startBold();
        writeLink(memdef,ol);
        ol.endBold();
        ol.docify(" ");
        return;
      }
    }
  }
  startFonts(mem,"vhdlchar",ol);
}// found component

引用了 OutputList::docify(), OutputList::endBold(), findMember(), MemberDef::getClassDef(), MemberDef::isLinkable(), Definition::name(), OutputList::startBold(), startFonts() , 以及 writeLink().

被这些函数引用 writeFormatString().

writeTagFile()

void VhdlDocGen::writeTagFile ( MemberDefMutable *  mdef, TextStream &  tagFile  )

static

在文件 vhdldocgen.cpp 第 1702 行定义.

{
  tagFile << "    <member kind=\"";
  if (VhdlDocGen::isGeneric(mdef))      tagFile << "generic";
  if (VhdlDocGen::isPort(mdef))         tagFile << "port";
  if (VhdlDocGen::isEntity(mdef))       tagFile << "entity";
  if (VhdlDocGen::isComponent(mdef))    tagFile << "component";
  if (VhdlDocGen::isVType(mdef))        tagFile << "type";
  if (VhdlDocGen::isConstant(mdef))     tagFile << "constant";
  if (VhdlDocGen::isSubType(mdef))      tagFile << "subtype";
  if (VhdlDocGen::isVhdlFunction(mdef)) tagFile << "function";
  if (VhdlDocGen::isProcedure(mdef))    tagFile << "procedure";
  if (VhdlDocGen::isProcess(mdef))      tagFile << "process";
  if (VhdlDocGen::isSignals(mdef))      tagFile << "signal";
  if (VhdlDocGen::isAttribute(mdef))    tagFile << "attribute";
  if (VhdlDocGen::isRecord(mdef))       tagFile << "record";
  if (VhdlDocGen::isLibrary(mdef))      tagFile << "library";
  if (VhdlDocGen::isPackage(mdef))      tagFile << "package";
  if (VhdlDocGen::isVariable(mdef))     tagFile << "shared variable";
  if (VhdlDocGen::isFile(mdef))         tagFile << "file";
  if (VhdlDocGen::isGroup(mdef))        tagFile << "group";
  if (VhdlDocGen::isCompInst(mdef))     tagFile << "instantiation";
  if (VhdlDocGen::isAlias(mdef))        tagFile << "alias";
  if (VhdlDocGen::isCompInst(mdef))     tagFile << "configuration";
 
  tagFile << "\">\n";
  tagFile << "      <type>" << convertToXML(mdef->typeString()) << "</type>\n";
  tagFile << "      <name>" << convertToXML(mdef->name()) << "</name>\n";
  tagFile << "      <anchorfile>" << convertToXML(addHtmlExtensionIfMissing(mdef->getOutputFileBase())) << "</anchorfile>\n";
  tagFile << "      <anchor>" << convertToXML(mdef->anchor()) << "</anchor>\n";
 
  if (VhdlDocGen::isVhdlFunction(mdef))
    tagFile << "      <arglist>" << convertToXML(VhdlDocGen::convertArgumentListToString(mdef->argumentList(),TRUE)) << "</arglist>\n";
  else if (VhdlDocGen::isProcedure(mdef))
    tagFile << "      <arglist>" << convertToXML(VhdlDocGen::convertArgumentListToString(mdef->argumentList(),FALSE)) << "</arglist>\n";
  else
    tagFile << "      <arglist>" << convertToXML(mdef->argsString()) << "</arglist>\n";
 
  mdef->writeDocAnchorsToTagFile(tagFile);
  tagFile << "    </member>\n";
}

引用了 addHtmlExtensionIfMissing(), MemberDef::anchor(), MemberDef::argsString(), MemberDef::argumentList(), convertArgumentListToString(), convertToXML(), FALSE, MemberDef::getOutputFileBase(), isAlias(), isAttribute(), isCompInst(), isComponent(), isConstant(), isEntity(), isFile(), isGeneric(), isGroup(), isLibrary(), isPackage(), isPort(), isProcedure(), isProcess(), isRecord(), isSignals(), isSubType(), isVariable(), isVhdlFunction(), isVType(), Definition::name(), TRUE, MemberDef::typeString() , 以及 DefinitionMutable::writeDocAnchorsToTagFile().

被这些函数引用 MemberList::writeTagFile().

writeVHDLDeclaration()

void VhdlDocGen::writeVHDLDeclaration ( const MemberDefMutable *  mdef, OutputList &  ol, const ClassDef *  cd, const NamespaceDef *  nd, const FileDef *  fd, const GroupDef *  gd, bool  inGroup  )

static

printf("startMemberItem for %s\n",qPrint(name()));

在文件 vhdldocgen.cpp 第 1746 行定义.

{
  const Definition *d=0;
 
  ASSERT(cd!=0 || nd!=0 || fd!=0 || gd!=0 ||
      mdef->getMemberSpecifiers()==VhdlDocGen::LIBRARY ||
      mdef->getMemberSpecifiers()==VhdlDocGen::USE
      ); // member should belong to something
  if (cd) d=cd;
  else if (nd) d=nd;
  else if (fd) d=fd;
  else if (gd) d=gd;
  else d=(Definition*)mdef;
 
  // write search index info
  if (Doxygen::searchIndex)
  {
    Doxygen::searchIndex->setCurrentDoc(mdef,mdef->anchor(),FALSE);
    Doxygen::searchIndex->addWord(mdef->localName(),TRUE);
    Doxygen::searchIndex->addWord(mdef->qualifiedName(),FALSE);
  }
 
  QCString cname  = d->name();
  QCString cfname = d->getOutputFileBase();
 
  //HtmlHelp *htmlHelp=0;
  //  bool hasHtmlHelp = Config_getBool(GENERATE_HTML) && Config_getBool(GENERATE_HTMLHELP);
  //  if (hasHtmlHelp) htmlHelp = HtmlHelp::getInstance();
 
  // search for the last anonymous scope in the member type
  ClassDef *annoClassDef=mdef->getClassDefOfAnonymousType();
 
  // start a new member declaration
  uint isAnonymous = (bool)(annoClassDef); // || m_impl->annMemb || m_impl->annEnumType;
  ///printf("startMemberItem for %s\n",qPrint(name()));
  uint64_t mm=mdef->getMemberSpecifiers();
  if (mm==VhdlDocGen::MISCELLANEOUS)
      isAnonymous=3;
 
   ol.startMemberItem( mdef->anchor(), isAnonymous ); //? 1 : m_impl->tArgList ? 3 : 0);
 
  // If there is no detailed description we need to write the anchor here.
  bool detailsVisible = mdef->hasDetailedDescription();
  if (!detailsVisible) // && !m_impl->annMemb)
  {
    QCString doxyName=mdef->name();
    if (!cname.isEmpty()) doxyName.prepend(cname+"::");
    QCString doxyArgs=mdef->argsString();
    ol.startDoxyAnchor(cfname,cname,mdef->anchor(),doxyName,doxyArgs);
 
    ol.pushGeneratorState();
    ol.disable(OutputGenerator::Man);
    ol.disable(OutputGenerator::Latex);
    ol.docify("\n");
    ol.popGeneratorState();
 
  }
  // *** write type
  /*VHDL CHANGE */
 
  QCString ltype(mdef->typeString());
  QCString largs(mdef->argsString());
 
  ClassDef *kl=0;
  const ArgumentList &al = mdef->argumentList();
  QCString nn;
  //VhdlDocGen::adjustRecordMember(mdef);
  if (gd) gd=0;
  switch (mm)
  {
    case VhdlDocGen::MISCELLANEOUS:
      VhdlDocGen::writeSource(mdef,ol,nn);
      break;
    case VhdlDocGen::PROCEDURE:
    case VhdlDocGen::FUNCTION:
      ol.startBold();
      VhdlDocGen::formatString(ltype,ol,mdef);
      ol.endBold();
      ol.insertMemberAlign();
      ol.docify(" ");
 
      writeLink(mdef,ol);
      if (al.hasParameters() && mm==VhdlDocGen::FUNCTION)
        VhdlDocGen::writeFunctionProto(ol,al,mdef);
 
      if (al.hasParameters() && mm==VhdlDocGen::PROCEDURE)
        VhdlDocGen::writeProcedureProto(ol,al,mdef);
 
      break;
    case VhdlDocGen::USE:
      kl=VhdlDocGen::getClass(mdef->name());
      if (kl && ((VhdlDocGen::VhdlClasses)kl->protection()==VhdlDocGen::ENTITYCLASS)) break;
      writeLink(mdef,ol);
      ol.insertMemberAlign();
      ol.docify("  ");
 
      if (kl)
      {
        nn=kl->getOutputFileBase();
        ol.pushGeneratorState();
        ol.disableAllBut(OutputGenerator::Html);
        ol.docify(" ");
        QCString name=theTranslator_vhdlType(VhdlDocGen::PACKAGE,TRUE);
        ol.startBold();
        ol.docify(name);
        name.resize(0);
        ol.endBold();
        name+=" <"+mdef->name()+">";
        ol.startEmphasis();
        ol.writeObjectLink(kl->getReference(),kl->getOutputFileBase(),QCString(),name);
        ol.popGeneratorState();
      }
      break;
    case VhdlDocGen::LIBRARY:
      writeLink(mdef,ol);
      ol.insertMemberAlign();
      if (largs=="context")
      {
        VhdlDocGen::writeRecordUnit(ltype,largs,ol,mdef);
      }
 
      break;
 
    case VhdlDocGen::GENERIC:
    case VhdlDocGen::PORT:
    case VhdlDocGen::ALIAS:
 
      writeLink(mdef,ol);
      ol.docify(" ");
      if (mm==VhdlDocGen::GENERIC)
      {
        ol.insertMemberAlign();
        ol.startBold();
        VhdlDocGen::formatString(largs,ol,mdef);
        ol.endBold();
      }
      else
      {
        ol.insertMemberAlignLeft(isAnonymous, false);
        ol.docify(" ");
        ol.startBold();
        VhdlDocGen::formatString(ltype,ol,mdef);
        ol.endBold();
        ol.insertMemberAlign();
        ol.docify(" ");
        VhdlDocGen::formatString(largs,ol,mdef);
      }
      break;
    case VhdlDocGen::PROCESS:
      writeLink(mdef,ol);
      ol.insertMemberAlign();
      VhdlDocGen::writeProcessProto(ol,al,mdef);
      break;
    case VhdlDocGen::PACKAGE:
    case VhdlDocGen::ENTITY:
    case VhdlDocGen::COMPONENT:
    case VhdlDocGen::INSTANTIATION:
    case VhdlDocGen::CONFIG:
      if (VhdlDocGen::isCompInst(mdef) )
      {
        nn=largs;
        if(nn.stripPrefix("function") || nn.stripPrefix("package"))
        {
          VhdlDocGen::formatString(largs,ol,mdef);
          ol.insertMemberAlign();
          writeLink(mdef,ol);
          ol.docify(" ");
          VhdlDocGen::formatString(ltype,ol,mdef);
          break;
        }
 
        largs.prepend("::");
        largs.prepend(mdef->name());
        ol.writeObjectLink(mdef->getReference(),
            cfname,
            mdef->anchor(),
            mdef->name());
      }
      else
        writeLink(mdef,ol);
 
      ol.insertMemberAlign();
      ol.docify("  ");
      ol.startBold();
      ol.docify(ltype);
      ol.endBold();
      ol.docify("  ");
      if (VhdlDocGen::isComponent(mdef) ||
          VhdlDocGen::isConfig(mdef)    ||
          VhdlDocGen::isCompInst(mdef))
      {
        if (VhdlDocGen::isConfig(mdef) || VhdlDocGen::isCompInst(mdef))
        {
          nn=ltype;
        }
        else
        {
          nn=mdef->name();
        }
        kl=getClass(nn);
        if (kl)
        {
          nn=kl->getOutputFileBase();
          ol.pushGeneratorState();
          ol.disableAllBut(OutputGenerator::Html);
          ol.startEmphasis();
          QCString name("<Entity ");
          if (VhdlDocGen::isConfig(mdef) || VhdlDocGen::isCompInst(mdef))
          {
            name+=ltype+">";
          }
          else
          {
            name+=mdef->name()+"> ";
          }
          ol.writeObjectLink(kl->getReference(),kl->getOutputFileBase(),QCString(),name);
          ol.endEmphasis();
          ol.popGeneratorState();
        }
      }
      break;
    case VhdlDocGen::UCF_CONST:
      writeUCFLink(mdef,ol);
      break;
    case VhdlDocGen::SIGNAL:
    case VhdlDocGen::ATTRIBUTE:
    case VhdlDocGen::SUBTYPE:
    case VhdlDocGen::CONSTANT:
    case VhdlDocGen::SHAREDVARIABLE:
    case VhdlDocGen::VFILE:
    case VhdlDocGen::GROUP:
    case VhdlDocGen::TYPE:
      writeLink(mdef,ol);
      ol.docify(" ");
      ol.insertMemberAlign();
      VhdlDocGen::formatString(ltype,ol,mdef);
      break;
    case VhdlDocGen::RECORD:
    case VhdlDocGen::UNITS:
     writeRecordUnit(largs,ltype,ol,mdef);
      break;
 
    default: break;
  }
 
  bool htmlOn = ol.isEnabled(OutputGenerator::Html);
  if (htmlOn && /*Config_getBool(HTML_ALIGN_MEMBERS) &&*/ !ltype.isEmpty())
  {
    ol.disable(OutputGenerator::Html);
  }
  if (!ltype.isEmpty()) ol.docify(" ");
 
  if (htmlOn)
  {
    ol.enable(OutputGenerator::Html);
  }
 
  if (!detailsVisible)// && !m_impl->annMemb)
  {
    ol.endDoxyAnchor(cfname,mdef->anchor());
  }
 
  ol.endMemberItem();
  if (!mdef->briefDescription().isEmpty() &&   Config_getBool(BRIEF_MEMBER_DESC) /* && !annMemb */)
  {
    QCString s=mdef->briefDescription();
    ol.startMemberDescription(mdef->anchor(), QCString(), mm == VhdlDocGen::PORT);
    ol.generateDoc(mdef->briefFile(),mdef->briefLine(),
                   mdef->getOuterScope()?mdef->getOuterScope():d,
                   mdef,s,TRUE,FALSE,
                   QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
    if (detailsVisible)
    {
      ol.pushGeneratorState();
      ol.disableAllBut(OutputGenerator::Html);
      //ol.endEmphasis();
      ol.docify(" ");
      if (mdef->getGroupDef()!=0 && gd==0) // forward link to the group
      {
        ol.startTextLink(mdef->getOutputFileBase(),mdef->anchor());
      }
      else // local link
      {
        ol.startTextLink(QCString(),mdef->anchor());
      }
      ol.endTextLink();
      //ol.startEmphasis();
      ol.popGeneratorState();
    }
    //ol.newParagraph();
    ol.endMemberDescription();
  }
  mdef->warnIfUndocumented();
 
}// end writeVhdlDeclaration

引用了 SearchIndexIntf::addWord(), ALIAS, MemberDef::anchor(), MemberDef::argsString(), MemberDef::argumentList(), ASSERT, ATTRIBUTE, MemberDef::briefDescription(), Definition::briefFile(), Definition::briefLine(), COMPONENT, CONFIG, Config_getBool, CONSTANT, OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enable(), OutputList::endBold(), OutputList::endDoxyAnchor(), OutputList::endEmphasis(), OutputList::endMemberDescription(), OutputList::endMemberItem(), OutputList::endTextLink(), ENTITY, ENTITYCLASS, FALSE, formatString(), FUNCTION, OutputList::generateDoc(), GENERIC, getClass(), MemberDef::getClassDefOfAnonymousType(), MemberDef::getGroupDef(), MemberDef::getMemberSpecifiers(), Definition::getOuterScope(), MemberDef::getOutputFileBase(), ClassDef::getOutputFileBase(), Definition::getOutputFileBase(), MemberDef::getReference(), ClassDef::getReference(), GROUP, MemberDef::hasDetailedDescription(), ArgumentList::hasParameters(), OutputGenerator::Html, OutputList::insertMemberAlign(), OutputList::insertMemberAlignLeft(), INSTANTIATION, isCompInst(), isComponent(), isConfig(), QCString::isEmpty(), OutputList::isEnabled(), OutputGenerator::Latex, LIBRARY, Definition::localName(), OutputGenerator::Man, MISCELLANEOUS, Definition::name(), PACKAGE, OutputList::popGeneratorState(), PORT, QCString::prepend(), PROCEDURE, PROCESS, ClassDef::protection(), OutputList::pushGeneratorState(), MemberDef::qualifiedName(), RECORD, QCString::resize(), Doxygen::searchIndex, SearchIndexIntf::setCurrentDoc(), SHAREDVARIABLE, SIGNAL, OutputList::startBold(), OutputList::startDoxyAnchor(), OutputList::startEmphasis(), OutputList::startMemberDescription(), OutputList::startMemberItem(), OutputList::startTextLink(), QCString::stripPrefix(), SUBTYPE, theTranslator_vhdlType, TRUE, TYPE, MemberDef::typeString(), UCF_CONST, UNITS, USE, VFILE, MemberDef::warnIfUndocumented(), writeFunctionProto(), writeLink(), OutputList::writeObjectLink(), writeProcedureProto(), writeProcessProto(), writeRecordUnit(), writeSource() , 以及 writeUCFLink().

被这些函数引用 writePlainVHDLDeclarations().

writeVhdlDeclarations()

void VhdlDocGen::writeVhdlDeclarations ( const MemberList *  ml, OutputList &  ol, const GroupDef *  gd, const ClassDef *  cd, const FileDef *  fd, const NamespaceDef *  nd  )

static

在文件 vhdldocgen.cpp 第 1539 行定义.

{
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::LIBRARY,FALSE),QCString(),FALSE,VhdlDocGen::LIBRARY);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::USE,FALSE),QCString(),FALSE,VhdlDocGen::USE);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::FUNCTION,FALSE),QCString(),FALSE,VhdlDocGen::FUNCTION);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::COMPONENT,FALSE),QCString(),FALSE,VhdlDocGen::COMPONENT);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::CONSTANT,FALSE),QCString(),FALSE,VhdlDocGen::CONSTANT);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::TYPE,FALSE),QCString(),FALSE,VhdlDocGen::TYPE);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::SUBTYPE,FALSE),QCString(),FALSE,VhdlDocGen::SUBTYPE);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::GENERIC,FALSE),QCString(),FALSE,VhdlDocGen::GENERIC);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::PORT,FALSE),QCString(),FALSE,VhdlDocGen::PORT);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::PROCESS,FALSE),QCString(),FALSE,VhdlDocGen::PROCESS);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::SIGNAL,FALSE),QCString(),FALSE,VhdlDocGen::SIGNAL);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::ATTRIBUTE,FALSE),QCString(),FALSE,VhdlDocGen::ATTRIBUTE);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::PROCEDURE,FALSE),QCString(),FALSE,VhdlDocGen::PROCEDURE);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::RECORD,FALSE),QCString(),FALSE,VhdlDocGen::RECORD);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::UNITS,FALSE),QCString(),FALSE,VhdlDocGen::UNITS);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::SHAREDVARIABLE,FALSE),QCString(),FALSE,VhdlDocGen::SHAREDVARIABLE);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::VFILE,FALSE),QCString(),FALSE,VhdlDocGen::VFILE);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::GROUP,FALSE),QCString(),FALSE,VhdlDocGen::GROUP);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::INSTANTIATION,FALSE),QCString(),FALSE,VhdlDocGen::INSTANTIATION);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::ALIAS,FALSE),QCString(),FALSE,VhdlDocGen::ALIAS);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::MISCELLANEOUS,TRUE),QCString(),FALSE,VhdlDocGen::MISCELLANEOUS);
 
  // configurations must be added to global file definitions.
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::CONFIG,FALSE),QCString(),FALSE,VhdlDocGen::CONFIG);
  VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,nd,fd,gd,theTranslator_vhdlType(VhdlDocGen::UCF_CONST,FALSE),QCString(),FALSE,VhdlDocGen::UCF_CONST);
 
}

引用了 ALIAS, ATTRIBUTE, COMPONENT, CONFIG, CONSTANT, FALSE, FUNCTION, GENERIC, GROUP, INSTANTIATION, LIBRARY, MISCELLANEOUS, PORT, PROCEDURE, PROCESS, RECORD, SHAREDVARIABLE, SIGNAL, SUBTYPE, theTranslator_vhdlType, TRUE, TYPE, UCF_CONST, UNITS, USE, VFILE , 以及 writeVHDLDeclarations().

被这些函数引用 MemberList::writeDeclarations(), GroupDefImpl::writeMemberDeclarations(), FileDefImpl::writeMemberDeclarations() , 以及 ClassDefImpl::writeMemberDeclarations().

writeVHDLDeclarations()

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

static

在文件 vhdldocgen.cpp 第 2098 行定义.

{
  if (!membersHaveSpecificType(ml,type)) return;
 
  if (!title.isEmpty())
  {
    ol.startMemberHeader(convertToId(title),type == VhdlDocGen::PORT ? 3 : 2);
    ol.parseText(title);
    ol.endMemberHeader();
    ol.docify(" ");
  }
  if (!subtitle.isEmpty())
  {
    ol.startMemberSubtitle();
    ol.generateDoc("[generated]",-1,0,0,subtitle,FALSE,FALSE,
                   QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
    ol.endMemberSubtitle();
  } //printf("memberGroupList=%p\n",memberGroupList);
 
  VhdlDocGen::writePlainVHDLDeclarations(ml,ol,cd,nd,fd,gd,type);
 
  for (const auto &mg : ml->getMemberGroupList())
  {
    if (membersHaveSpecificType(&mg->members(),type))
    {
      //printf("mg->header=%s\n",qPrint(mg->header()));
      bool hasHeader=mg->header()!="[NOHEADER]";
      ol.startMemberGroupHeader(hasHeader);
      if (hasHeader)
      {
        ol.parseText(mg->header());
      }
      ol.endMemberGroupHeader();
      if (!mg->documentation().isEmpty())
      {
        //printf("Member group has docs!\n");
        ol.startMemberGroupDocs();
        ol.generateDoc("[generated]",-1,0,0,mg->documentation()+"\n",FALSE,FALSE,
            QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
        ol.endMemberGroupDocs();
      }
      ol.startMemberGroup();
      //printf("--- mg->writePlainDeclarations ---\n");
      VhdlDocGen::writePlainVHDLDeclarations(&mg->members(),ol,cd,nd,fd,gd,type);
      ol.endMemberGroup(hasHeader);
    }
  }
}// writeVHDLDeclarations

引用了 Config_getBool, convertToId(), OutputList::docify(), OutputList::endMemberGroup(), OutputList::endMemberGroupDocs(), OutputList::endMemberGroupHeader(), OutputList::endMemberHeader(), OutputList::endMemberSubtitle(), FALSE, OutputList::generateDoc(), MemberList::getMemberGroupList(), QCString::isEmpty(), membersHaveSpecificType(), OutputList::parseText(), PORT, OutputList::startMemberGroup(), OutputList::startMemberGroupDocs(), OutputList::startMemberGroupHeader(), OutputList::startMemberHeader(), OutputList::startMemberSubtitle(), TRUE , 以及 writePlainVHDLDeclarations().

被这些函数引用 writeVhdlDeclarations().

writeVhdlLink()

void VhdlDocGen::writeVhdlLink ( const ClassDef *  cdd, OutputList &  ol, QCString &  type, QCString &  name, QCString &  beh  )

staticprivate

在文件 vhdldocgen.cpp 第 944 行定义.

{
  if (ccd==0)  return;
  ol.startBold();
  ol.docify(type);
  ol.endBold();
  nn.stripPrefix("_");
  ol.writeObjectLink(ccd->getReference(),ccd->getOutputFileBase(),QCString(),nn);
 
  if (!behav.isEmpty())
  {
    behav.prepend("  ");
    ol.startBold();
    ol.docify(behav);
    ol.endBold();
  }
 
  ol.lineBreak();
}

引用了 OutputList::docify(), OutputList::endBold(), ClassDef::getOutputFileBase(), ClassDef::getReference(), QCString::isEmpty(), OutputList::lineBreak(), QCString::prepend(), OutputList::startBold(), QCString::stripPrefix() , 以及 OutputList::writeObjectLink().

被这些函数引用 writeInlineClassLink().

writeVHDLTypeDocumentation()

bool VhdlDocGen::writeVHDLTypeDocumentation ( const MemberDef *  mdef, const Definition *  d, OutputList &  ol  )

static

在文件 vhdldocgen.cpp 第 1618 行定义.

{
  const ClassDef *cd=toClassDef(d);
  bool hasParams = FALSE;
 
  if (cd==0) return hasParams;
 
  QCString ttype=mdef->typeString();
  QCString largs=mdef->argsString();
 
  if ((VhdlDocGen::isVhdlFunction(mdef) || VhdlDocGen::isProcedure(mdef) || VhdlDocGen::isProcess(mdef)))
  {
    QCString nn=mdef->typeString();
    nn=nn.stripWhiteSpace();
    QCString na=cd->name();
    const MemberDef* memdef=VhdlDocGen::findMember(na,nn);
    if (memdef && memdef->isLinkable())
    {
      ol.docify(" ");
 
      ol.startBold();
      writeLink(memdef,ol);
      ol.endBold();
      ol.docify(" ");
    }
    else
    {
      ol.docify(" ");
      VhdlDocGen::formatString(ttype,ol,mdef);
      ol.docify(" ");
    }
    ol.docify(mdef->name());
    hasParams = VhdlDocGen::writeFuncProcDocu(mdef,ol, mdef->argumentList());
  }
 
 
  if (mdef->isVariable())
  {
    if (VhdlDocGen::isConstraint(mdef))
    {
      writeLink(mdef,ol);
      ol.docify(" ");
 
      largs=substitute(largs,"#"," ");
      VhdlDocGen::formatString(largs,ol,mdef);
      return hasParams;
    }
    else
    {
      writeLink(mdef,ol);
      if (VhdlDocGen::isLibrary(mdef) || VhdlDocGen::isPackage(mdef))
      {
        return hasParams;
      }
      ol.docify(" ");
    }
 
    // QCString largs=mdef->argsString();
 
    bool c=largs=="context";
    bool brec=largs.stripPrefix("record")  ;
 
    if (!brec && !c)
      VhdlDocGen::formatString(ttype,ol,mdef);
 
    if (c || brec || largs.stripPrefix("units"))
    {
      if (c)
          largs=ttype;
      VhdlDocGen::writeRecUnitDocu(mdef,ol,largs);
      return hasParams;
    }
 
    ol.docify(" ");
    if (VhdlDocGen::isPort(mdef) || VhdlDocGen::isGeneric(mdef))
    {
      // QCString largs=mdef->argsString();
      VhdlDocGen::formatString(largs,ol,mdef);
      ol.docify(" ");
    }
  }
  return hasParams;
}

引用了 MemberDef::argsString(), MemberDef::argumentList(), OutputList::docify(), OutputList::endBold(), FALSE, findMember(), formatString(), isConstraint(), isGeneric(), isLibrary(), MemberDef::isLinkable(), isPackage(), isPort(), isProcedure(), isProcess(), MemberDef::isVariable(), isVhdlFunction(), Definition::name(), OutputList::startBold(), QCString::stripPrefix(), QCString::stripWhiteSpace(), substitute(), toClassDef(), MemberDef::typeString(), writeFuncProcDocu(), writeLink() , 以及 writeRecUnitDocu().

被这些函数引用 MemberDefImpl::writeDocumentation().

---

该类的文档由以下文件生成:

• src/vhdldocgen.h
• src/vhdldocgen.cpp