RefList类 参考

List of cross-referenced items 更多...

#include <reflist.h>

RefList 的协作图:

Public 成员函数
	RefList (const QCString &listName, const QCString &pageTitle, const QCString &secTitle)
bool	isEnabled () const
RefItem *	add ()
RefItem *	find (int itemId)
QCString	listName () const
QCString	fileName () const
QCString	pageTitle () const
QCString	sectionTitle () const
void	generatePage ()

Private 属性
int	m_id = 0
QCString	m_listName
QCString	m_fileName
QCString	m_pageTitle
QCString	m_secTitle
std::vector< std::unique_ptr< RefItem > >	m_entries
std::unordered_map< int, RefItem * >	m_lookup

详细描述

List of cross-referenced items

This class represents a list of items that are put at a certain point in the documentation by some special command and are collected in a list. The items cross-reference the documentation and the list.

Examples are the todo list, the test list and the bug list, introduced by the \todo, \test, and \bug commands respectively.

在文件 reflist.h 第 78 行定义.

构造及析构函数说明

RefList()

RefList::RefList	(	const QCString &	listName,
		const QCString &	pageTitle,
		const QCString &	secTitle
	)

Create a list of items that are cross referenced with documentation blocks

参数

listName	String representing the name of the list.
pageTitle	String representing the title of the list page.
secTitle	String representing the title of the section.

在文件 reflist.cpp 第 24 行定义.

                                                                                              :
       m_listName(listName), m_fileName(convertNameToFile(listName,FALSE,TRUE)),
       m_pageTitle(pageTitle), m_secTitle(secTitle)
{
}

成员函数说明

add()

RefItem * RefList::add

(

)

Adds a new item to the list.

返回

A unique id for this item.

在文件 reflist.cpp 第 30 行定义.

{
  m_id++;
  std::unique_ptr<RefItem> item = std::make_unique<RefItem>(m_id,this);
  RefItem *result = item.get();
  m_entries.push_back(std::move(item));
  m_lookup.insert({m_id,result});
  return result;
}

引用了 m_entries, m_id , 以及 m_lookup.

fileName()

QCString RefList::fileName ( ) const

inline

在文件 reflist.h 第 101 行定义.

{ return m_fileName;  }

引用了 m_fileName.

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

find()

RefItem * RefList::find

(

int

itemId

)

Returns an item given it's id that is obtained with addRefItem()

参数

itemId

item's identifier.

返回

A pointer to the todo item's structure.

在文件 reflist.cpp 第 40 行定义.

{
  auto it = m_lookup.find(itemId);
  return it!=m_lookup.end() ? it->second : nullptr;
}

引用了 m_lookup.

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

generatePage()

void RefList::generatePage

(

)

在文件 reflist.cpp 第 55 行定义.

{
  if (!isEnabled()) return;
 
  std::sort(m_entries.begin(),m_entries.end(),
            [](std::unique_ptr<RefItem> &left,std::unique_ptr<RefItem> &right)
            { return qstricmp(left->title(),right->title()) < 0; });
  //RefItem *item;
  QCString doc;
  int cnt = 0;
  doc += "<dl class=\"reflist\">";
  QCString lastGroup;
  bool first=true;
  for (const std::unique_ptr<RefItem> &item : m_entries)
  {
    if (item->name().isEmpty()) continue;
    cnt++;
    bool startNewGroup = item->group()!=lastGroup;
    if (startNewGroup)
    {
      if (!first)
      {
        doc += "</dd>";
      }
      first=false;
      doc += " <dt>";
      doc += "\n";
      if (item->scope())
      {
        if (item->scope()->name() != "<globalScope>")
        {
          doc += "\\_setscope ";
          doc += item->scope()->name();
          doc += " ";
        }
      }
      doc += item->prefix();
      doc += " \\_internalref ";
      doc += item->name();
      // escape \'s in title, see issue #5901
      QCString escapedTitle = substitute(item->title(),"\\","\\\\");
      doc += " \""+escapedTitle+"\" ";
      // write declaration in case a function with arguments
      if (!item->args().isEmpty())
      {
        // escape @'s in argument list, needed for Java annotations (see issue #6208)
        // escape \'s in argument list (see issue #6533)
        doc += substitute(substitute(item->args(),"@","@@"),"\\","\\\\");
      }
      doc += "</dt><dd>";
    }
    else
    {
      doc += "<p>";
    }
    doc += " \\anchor ";
    doc += item->anchor();
    doc += " ";
    doc += item->text();
    lastGroup = item->group();
    first = false;
  }
  if (!first)
  {
    doc += "</dd>";
  }
  doc += "</dl>\n";
  //printf("generatePage('%s')\n",doc.data());
  if (cnt>0)
  {
    addRelatedPage(m_listName,m_pageTitle,doc,m_fileName,1,1,RefItemVector(),0,0,TRUE);
  }
}

引用了 addRelatedPage(), isEnabled(), m_entries, m_fileName, m_listName, m_pageTitle, substitute() , 以及 TRUE.

isEnabled()

bool RefList::isEnabled

(

)

const

在文件 reflist.cpp 第 46 行定义.

{
  if      (m_listName=="todo"       && !Config_getBool(GENERATE_TODOLIST))       return false;
  else if (m_listName=="test"       && !Config_getBool(GENERATE_TESTLIST))       return false;
  else if (m_listName=="bug"        && !Config_getBool(GENERATE_BUGLIST))        return false;
  else if (m_listName=="deprecated" && !Config_getBool(GENERATE_DEPRECATEDLIST)) return false;
  return true;
}

引用了 Config_getBool , 以及 m_listName.

被这些函数引用 generatePage() , 以及 DocXRefItem::parse().

listName()

QCString RefList::listName ( ) const

inline

在文件 reflist.h 第 100 行定义.

{ return m_listName;  }

引用了 m_listName.

被这些函数引用 DefinitionImpl::_getXRefListId().

pageTitle()

QCString RefList::pageTitle ( ) const

inline

在文件 reflist.h 第 102 行定义.

{ return m_pageTitle; }

引用了 m_pageTitle.

sectionTitle()

QCString RefList::sectionTitle ( ) const

inline

在文件 reflist.h 第 103 行定义.

{ return m_secTitle;  }

引用了 m_secTitle.

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

类成员变量说明

m_entries

std::vector< std::unique_ptr< RefItem > > RefList::m_entries

private

在文件 reflist.h 第 113 行定义.

被这些函数引用 add() , 以及 generatePage().

m_fileName

QCString RefList::m_fileName

private

在文件 reflist.h 第 110 行定义.

被这些函数引用 fileName() , 以及 generatePage().

m_id

int RefList::m_id = 0

private

在文件 reflist.h 第 108 行定义.

被这些函数引用 add().

m_listName

QCString RefList::m_listName

private

在文件 reflist.h 第 109 行定义.

被这些函数引用 generatePage(), isEnabled() , 以及 listName().

m_lookup

std::unordered_map< int, RefItem* > RefList::m_lookup

private

在文件 reflist.h 第 114 行定义.

被这些函数引用 add() , 以及 find().

m_pageTitle

QCString RefList::m_pageTitle

private

在文件 reflist.h 第 111 行定义.

被这些函数引用 generatePage() , 以及 pageTitle().

m_secTitle

QCString RefList::m_secTitle

private

在文件 reflist.h 第 112 行定义.

被这些函数引用 sectionTitle().

---

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

• src/reflist.h
• src/reflist.cpp