Skip to main content

The Sitemap Class Reference

Declaration​

class Sitemap { ... }

Included Headers​

#include <src/sitemap.h>

Base class​

classIndexIntf

Abstract interface for index generators. More...

Public Constructors Index​

Sitemap ()

Public Destructor Index​

~Sitemap ()

Public Member Functions Index​

voidinitialize ()
voidfinalize ()
voidincContentsDepth ()
voiddecContentsDepth ()
voidaddContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def, const QCString &nameAsHtml)
voidaddIndexItem (const Definition *context, const MemberDef *md, const QCString &sectionAnchor, const QCString &title)
voidaddIndexFile (const QCString &name)
voidaddImageFile (const QCString &name)
voidaddStyleSheetFile (const QCString &name)

Private Member Attributes Index​

std::unique_ptr< Private >p

Public Static Attributes Index​

static const QCStringsitemapFileName = "sitemap.xml"

Definition at line 26 of file sitemap.h.

Public Constructors​

Sitemap()​

Sitemap::Sitemap ()

Declaration at line 29 of file sitemap.h, definition at line 43 of file sitemap.cpp.

43Sitemap::Sitemap() : p(std::make_unique<Private>()) {}

Reference p.

Referenced by ~Sitemap.

Public Destructor​

~Sitemap()​

Sitemap::~Sitemap ()

Definition at line 30 of file sitemap.h.

Reference Sitemap.

Public Member Functions​

addContentsItem()​

void Sitemap::addContentsItem (bool isDir, const QCString & name, const QCString & ref, const QCString & file, const QCString & anchor, bool separateIndex, bool addToNavIndex, const Definition * def, const QCString & nameAsHtml)
 inline virtual

Definition at line 37 of file sitemap.h.

37 void addContentsItem(bool isDir, const QCString &name, const QCString &ref,
38 const QCString &file, const QCString &anchor,
39 bool separateIndex, bool addToNavIndex,
40 const Definition *def, const QCString &nameAsHtml) {}

addImageFile()​

void Sitemap::addImageFile (const QCString & name)
 inline virtual

Definition at line 44 of file sitemap.h.

44 void addImageFile(const QCString & name) {}

addIndexFile()​

void Sitemap::addIndexFile (const QCString & name)
 virtual

Declaration at line 43 of file sitemap.h, definition at line 72 of file sitemap.cpp.

72void Sitemap::addIndexFile(const QCString & fileName)
73{
74 QCString fn = fileName;
75 QCString sidemapUrl = Config_getString(SITEMAP_URL);
76 addHtmlExtensionIfMissing(fn);
77 p->doc << " <url>\n";
78 p->doc << " <loc>" << convertToXML(sidemapUrl + fn) << "</loc>\n";
79 p->doc << " </url>\n";
80}

References addHtmlExtensionIfMissing, Config_getString, convertToXML and p.

addIndexItem()​

void Sitemap::addIndexItem (const Definition * context, const MemberDef * md, const QCString & sectionAnchor, const QCString & title)
 inline virtual

Definition at line 41 of file sitemap.h.

41 void addIndexItem(const Definition *context, const MemberDef *md,
42 const QCString &sectionAnchor, const QCString &title) {}

addStyleSheetFile()​

void Sitemap::addStyleSheetFile (const QCString & name)
 inline virtual

Definition at line 45 of file sitemap.h.

45 void addStyleSheetFile(const QCString & name) {}

decContentsDepth()​

void Sitemap::decContentsDepth ()
 inline virtual

Definition at line 36 of file sitemap.h.

36 void decContentsDepth(){}

finalize()​

void Sitemap::finalize ()
 virtual

Declaration at line 34 of file sitemap.h, definition at line 65 of file sitemap.cpp.

65void Sitemap::finalize()
66{
67 p->doc << "</urlset>\n";
68 p->doc.flush();
69 p->docFile.close();
70}

Reference p.

incContentsDepth()​

void Sitemap::incContentsDepth ()
 inline virtual

Definition at line 35 of file sitemap.h.

35 void incContentsDepth(){}

initialize()​

void Sitemap::initialize ()
 virtual

Declaration at line 33 of file sitemap.h, definition at line 46 of file sitemap.cpp.

46void Sitemap::initialize()
47{
48 QCString fileName = Config_getString(HTML_OUTPUT) + "/" + sitemapFileName;
49
50 p->docFile = Portable::openOutputStream(fileName);
51 if (!p->docFile.is_open())
52 {
53 term("Could not open file {} for writing\n", fileName);
54 }
55 p->doc.setStream(&p->docFile);
56
57 p->doc << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
58 p->doc << "<urlset\n";
59 p->doc << " xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"\n";
60 p->doc << " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n";
61 p->doc << " xsi:schemaLocation=\"http://www.sitemaps.org/schemas/sitemap/0.9\n";
62 p->doc << " http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd\">\n";
63}

References Config_getString, Portable::openOutputStream, p, sitemapFileName and term.

Private Member Attributes​

p​

std::unique_ptr<Private> Sitemap::p

Definition at line 51 of file sitemap.h.

51 std::unique_ptr<Private> p;

Referenced by addIndexFile, finalize, initialize and Sitemap.

Public Static Attributes​

sitemapFileName​

const QCString Sitemap::sitemapFileName = "sitemap.xml"
 static

Definition at line 47 of file sitemap.h.

47 static inline const QCString sitemapFileName = "sitemap.xml";

Referenced by initialize.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.