|
ISLEman
|
List of cross-referenced items. More...
#include <reflist.h>
Public Member Functions | |
| int | addRefItem () |
| RefItem * | getRefItem (int todoItemId) |
| RefItem * | getFirstRefItem () |
| RefItem * | getNextRefItem () |
| QCString | listName () const |
| QCString | fileName () const |
| QCString | pageTitle () const |
| QCString | sectionTitle () const |
| RefList (const char *listName, const char *pageTitle, const char *secTitle) | |
| ~RefList () | |
| void | insertIntoList (const char *key, RefItem *item) |
| void | generatePage () |
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::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. |
| RefList::~RefList | ( | ) |
Destroy the todo list. Currently not called!
| int RefList::addRefItem | ( | ) |
Adds a new item to the list.
| RefItem * RefList::getFirstRefItem | ( | ) |
Returns the first item in the dictionary or 0 if non is available. Items are not sorted.
| 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.
| RefItem * RefList::getRefItem | ( | int | itemId | ) |
Returns an item given it's id that is obtained with addRefItem()
| itemId | item's identifier. |
| QCString RefList::listName | ( | ) | const |
Returns the name of the list as set in the constructor.
1.8.12