DocCite Class Reference

#include <docparser.h>

Inheritance diagram for DocCite:

Public Member Functions
	DocCite (DocNode *parent, const QCString &target, const QCString &context)
Kind	kind () const
QCString	file () const
QCString	relPath () const
QCString	ref () const
QCString	anchor () const
QCString	text () const
void	accept (DocVisitor *v)
Public Member Functions inherited from DocNode
	DocNode ()
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private Attributes
QCString	m_file
QCString	m_relPath
QCString	m_ref
QCString	m_anchor
QCString	m_text

Additional Inherited Members
Public Types inherited from DocNode
enum	Kind {   Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,   Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,   Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,   Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,   Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,   Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,   Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,   Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,   Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,   Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,   Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,   Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,   Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,   Kind_DiaFile = 52 }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)
Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing a citation of some bibliographic reference

Definition at line 287 of file docparser.h.

Constructor & Destructor Documentation

DocCite::DocCite	(	DocNode *	parent,
		const QCString &	target,
		const QCString &	context
	)

Definition at line 2600 of file docparser.cpp.

{
  static uint numBibFiles = Config_getList("CITE_BIB_FILES").count();
  m_parent = parent;
  //printf("DocCite::DocCite(target=%s)\n",target.data());
  ASSERT(!target.isEmpty());
  m_relPath = g_relPath;
  CiteInfo *cite = Doxygen::citeDict->find(target);
  //printf("cite=%p text='%s' numBibFiles=%d\n",cite,cite?cite->text.data():"<null>",numBibFiles);
  if (numBibFiles>0 && cite && !cite->text.isEmpty()) // ref to citation
  {
    m_text         = cite->text;
    m_ref          = cite->ref;
    m_anchor       = CiteConsts::anchorPrefix+cite->label;
    m_file         = convertNameToFile(CiteConsts::fileName,FALSE,TRUE);
    //printf("CITE ==> m_text=%s,m_ref=%s,m_file=%s,m_anchor=%s\n",
    //    m_text.data(),m_ref.data(),m_file.data(),m_anchor.data());
    return;
  }
  m_text = target;
  if (numBibFiles==0)
  {
    warn_doc_error(g_fileName,doctokenizerYYlineno,"\\cite command found but no bib files specified via CITE_BIB_FILES!");
  }
  else if (cite==0)
  {
    warn_doc_error(g_fileName,doctokenizerYYlineno,"unable to resolve reference to `%s' for \\cite command",
             qPrint(target));
  }
  else
  {
    warn_doc_error(g_fileName,doctokenizerYYlineno,"\\cite command to '%s' does not have an associated number",
             qPrint(target));
  }
}

Member Function Documentation

void DocCite::accept ( DocVisitor *  v )

inlinevirtual

Acceptor function for node visitors. Part of the visitor pattern.

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 297 of file docparser.h.

{ v->visit(this); }

QCString DocCite::anchor ( ) const

inline

Definition at line 295 of file docparser.h.

{ return m_anchor; }

QCString DocCite::file ( ) const

inline

Definition at line 292 of file docparser.h.

{ return m_file; }

Kind DocCite::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 291 of file docparser.h.

{ return Kind_Ref; }

QCString DocCite::ref ( ) const

inline

Definition at line 294 of file docparser.h.

{ return m_ref; }

QCString DocCite::relPath ( ) const

inline

Definition at line 293 of file docparser.h.

{ return m_relPath; }

QCString DocCite::text ( ) const

inline

Definition at line 296 of file docparser.h.

{ return m_text; }

Member Data Documentation

QCString DocCite::m_anchor

private

Definition at line 303 of file docparser.h.

QCString DocCite::m_file

private

Definition at line 300 of file docparser.h.

QCString DocCite::m_ref

private

Definition at line 302 of file docparser.h.

QCString DocCite::m_relPath

private

Definition at line 301 of file docparser.h.

QCString DocCite::m_text

private

Definition at line 304 of file docparser.h.

---

The documentation for this class was generated from the following files:

• doxygen-1.8.11/src/docparser.h
• doxygen-1.8.11/src/docparser.cpp