NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
DocumentationEntry Struct Reference

This structure defines a single entry in the documentation index. More...

#include <docfile.hpp>

Collaboration diagram for DocumentationEntry:

Public Attributes

std::string sArticleId
 
std::string sDocFilePath
 
std::string sTitle
 
std::string sIdxKeys
 

Detailed Description

This structure defines a single entry in the documentation index.

Definition at line 29 of file docfile.hpp.

Member Data Documentation

◆ sArticleId

std::string DocumentationEntry::sArticleId

Definition at line 31 of file docfile.hpp.

Referenced by DocumentationArticle::format(), and parseHeader().

◆ sDocFilePath

std::string DocumentationEntry::sDocFilePath

Definition at line 32 of file docfile.hpp.

Referenced by DocumentationArticle::DocumentationArticle().

◆ sIdxKeys

std::string DocumentationEntry::sIdxKeys

Definition at line 34 of file docfile.hpp.

Referenced by Documentation::addEntry(), DocumentationArticle::format(), and parseHeader().

◆ sTitle

std::string DocumentationEntry::sTitle

Definition at line 33 of file docfile.hpp.

Referenced by DocumentationArticle::format(), and parseHeader().


The documentation for this struct was generated from the following file: