QcepDocumentationDictionary Class Reference

#include <qcepdocumentationdictionary.h>

Public Member Functions
	QcepDocumentationDictionary ()
void	setProto (QString name, QString proto)
void	setDoc (QString name, QString doc)
void	setLongDoc (QString name, QString doc)
QString	proto (QString name)
QString	doc (QString name)
QString	longDoc (QString name)

Static Public Member Functions
static QString	get_Proto (QString name)
static QString	get_Doc (QString name)
static QString	get_LongDoc (QString name)
static void	set_Proto (QString name, QString proto)
static void	set_Doc (QString name, QString doc)
static void	set_LongDoc (QString name, QString longDoc)
static QHash< QString, QString >	docs ()
static QHash< QString, QString >	protos ()
static QHash< QString, QString >	longDocs ()

Private Attributes
QHash< QString, QString >	m_Protos
QHash< QString, QString >	m_Docs
QHash< QString, QString >	m_LongDocs

Detailed Description

Definition at line 28 of file qcepdocumentationdictionary.h.

Constructor & Destructor Documentation

QcepDocumentationDictionary::QcepDocumentationDictionary

(

)

Definition at line 5 of file qcepdocumentationdictionary.cpp.

{
}

Member Function Documentation

QString QcepDocumentationDictionary::doc

(

QString

name

)

Definition at line 29 of file qcepdocumentationdictionary.cpp.

References m_Docs.

Referenced by get_Doc().

{
  return m_Docs.value(name);
}

Here is the caller graph for this function:

QHash< QString, QString > QcepDocumentationDictionary::docs ( )

static

Definition at line 115 of file qcepdocumentationdictionary.cpp.

References m_Docs.

Referenced by QcepScriptEngine::documentationText().

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->m_Docs;
  } else {
    return QHash<QString,QString>();
  }
}

Here is the caller graph for this function:

QString QcepDocumentationDictionary::get_Doc ( QString  name )

static

Definition at line 48 of file qcepdocumentationdictionary.cpp.

References doc().

Referenced by QcepScriptEngine::documentationLink(), and QcepScriptEngine::documentationText().

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->doc(name);
  } else {
    return QString();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

QString QcepDocumentationDictionary::get_LongDoc ( QString  name )

static

Definition at line 57 of file qcepdocumentationdictionary.cpp.

References longDoc().

Referenced by QcepScriptEngine::documentationText().

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->longDoc(name);
  } else {
    return QString();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

QString QcepDocumentationDictionary::get_Proto ( QString  name )

static

Definition at line 39 of file qcepdocumentationdictionary.cpp.

References proto().

Referenced by QcepScriptEngine::documentationLink(), and QcepScriptEngine::documentationText().

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->proto(name);
  } else {
    return QString();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

QString QcepDocumentationDictionary::longDoc

(

QString

name

)

Definition at line 34 of file qcepdocumentationdictionary.cpp.

References m_LongDocs.

Referenced by get_LongDoc().

{
  return m_LongDocs.value(name);
}

Here is the caller graph for this function:

QHash< QString, QString > QcepDocumentationDictionary::longDocs ( )

static

Definition at line 133 of file qcepdocumentationdictionary.cpp.

References m_LongDocs.

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->m_LongDocs;
  } else {
    return QHash<QString,QString>();
  }
}

QString QcepDocumentationDictionary::proto

(

QString

name

)

Definition at line 24 of file qcepdocumentationdictionary.cpp.

References m_Protos.

Referenced by get_Proto().

{
  return m_Protos.value(name);
}

Here is the caller graph for this function:

QHash< QString, QString > QcepDocumentationDictionary::protos ( )

static

Definition at line 124 of file qcepdocumentationdictionary.cpp.

References m_Protos.

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->m_Protos;
  } else {
    return QHash<QString,QString>();
  }
}

void QcepDocumentationDictionary::set_Doc ( QString  name, QString  doc  )

static

Definition at line 73 of file qcepdocumentationdictionary.cpp.

References setDoc().

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->setDoc(name, doc);
  }
}

Here is the call graph for this function:

void QcepDocumentationDictionary::set_LongDoc ( QString  name, QString  longDoc  )

static

Definition at line 80 of file qcepdocumentationdictionary.cpp.

References setLongDoc().

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->setLongDoc(name, longDoc);
  }
}

Here is the call graph for this function:

void QcepDocumentationDictionary::set_Proto ( QString  name, QString  proto  )

static

Definition at line 66 of file qcepdocumentationdictionary.cpp.

References setProto().

{
  if (gDocumentationDirectory) {
    return gDocumentationDirectory->setProto(name, proto);
  }
}

Here is the call graph for this function:

void QcepDocumentationDictionary::setDoc	(	QString	name,
		QString	doc
	)

Definition at line 14 of file qcepdocumentationdictionary.cpp.

References m_Docs.

Referenced by QcepDocumentationForObject::QcepDocumentationForObject(), and set_Doc().

{
  m_Docs.insert(name, doc);
}

Here is the caller graph for this function:

void QcepDocumentationDictionary::setLongDoc	(	QString	name,
		QString	doc
	)

Definition at line 19 of file qcepdocumentationdictionary.cpp.

References m_LongDocs.

Referenced by QcepDocumentationForFunction::QcepDocumentationForFunction(), QcepLongDocumentationForObject::QcepLongDocumentationForObject(), and set_LongDoc().

{
  m_LongDocs.insert(name, doc);
}

Here is the caller graph for this function:

void QcepDocumentationDictionary::setProto	(	QString	name,
		QString	proto
	)

Definition at line 9 of file qcepdocumentationdictionary.cpp.

References m_Protos.

Referenced by QcepDocumentationForFunction::QcepDocumentationForFunction(), and set_Proto().

{
  m_Protos.insert(name, proto);
}

Here is the caller graph for this function:

Member Data Documentation

QHash<QString,QString> QcepDocumentationDictionary::m_Docs

private

Definition at line 55 of file qcepdocumentationdictionary.h.

Referenced by doc(), docs(), and setDoc().

QHash<QString,QString> QcepDocumentationDictionary::m_LongDocs

private

Definition at line 56 of file qcepdocumentationdictionary.h.

Referenced by longDoc(), longDocs(), and setLongDoc().

QHash<QString,QString> QcepDocumentationDictionary::m_Protos

private

Definition at line 54 of file qcepdocumentationdictionary.h.

Referenced by proto(), protos(), and setProto().

---

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

• qcepdocumentationdictionary.h (Commit a65ccc9... : jennings : 2016-03-15 14:00:18 -0500)
• qcepdocumentationdictionary.cpp (Commit a65ccc9... : jennings : 2016-03-15 14:00:18 -0500)