#include <reflist.h>
Public Member Functions | |
| int | addRefItem () |
| RefItem * | getRefItem (int todoItemId) |
| RefItem * | getFirstRefItem () |
| RefItem * | getNextRefItem () |
| QCString | listName () const |
| QCString | pageTitle () const |
| QCString | sectionTitle () const |
| RefList (const char *listName, const char *pageTitle, const char *secTitle) | |
| ~RefList () | |
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.
Definition at line 45 of file reflist.h.
| RefList::RefList | ( | const char * | listName, | |
| const char * | pageTitle, | |||
| const char * | 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. |
Definition at line 26 of file reflist.cpp.
| RefList::~RefList | ( | ) |
Destroy the todo list. Currently not called!
Definition at line 40 of file reflist.cpp.
| int RefList::addRefItem | ( | ) |
Adds a new item to the list.
Definition at line 49 of file reflist.cpp.
| RefItem * RefList::getRefItem | ( | int | itemId | ) |
Returns an item given it's id that is obtained with addRefItem()
| itemId | item's identifier. |
Definition at line 67 of file reflist.cpp.
Referenced by DocXRefItem::parse().
| RefItem * RefList::getFirstRefItem | ( | ) |
Returns the first item in the dictionary or 0 if non is available. Items are not sorted.
Definition at line 76 of file reflist.cpp.
| RefItem * RefList::getNextRefItem | ( | ) |
Returns the next item in the dictionary or 0 if we are at the end of the list. Items are not sorted.
Definition at line 85 of file reflist.cpp.
| QCString RefList::listName | ( | ) | const |
Returns the name of the list as set in the constructor.
Definition at line 91 of file reflist.cpp.
Referenced by DocXRefItem::parse(), and PageDef::writeDocumentation().
| QCString RefList::pageTitle | ( | ) | const |
Definition at line 96 of file reflist.cpp.
| QCString RefList::sectionTitle | ( | ) | const |
1.5.1