The qhp.cpp File Reference

Included Headers

#include <algorithm> #include <memory> #include <string.h> #include <vector> #include <cassert> #include <mutex> #include "config.h" #include "debug.h" #include "doxygen.h" #include "groupdef.h" #include "memberdef.h" #include "message.h" #include "qhp.h" #include "textstream.h" #include "util.h" #include "portable.h" #include "language.h" #include "version.h"

Classes Index

class	QhpSectionTree
struct	Node
class	Private

Functions Index

static void	writeIndent (TextStream &t, int indent)
static QCString	getFullProjectName ()
static QCString	makeFileName (const QCString &withoutExtension)
static QCString	makeRef (const QCString &withoutExtension, const QCString &anchor)

Variables Index

static std::once_flag	g_blankWritten

Functions

getFullProjectName()

QCString getFullProjectName ()

static

Definition at line 161 of file qhp.cpp.

161static QCString getFullProjectName()

162{

163 QCString projectName = Config_getString(PROJECT_NAME);

164 QCString versionText = Config_getString(PROJECT_NUMBER);

165 if (projectName.isEmpty()) projectName="Root";

166 if (!versionText.isEmpty()) projectName+=" "+versionText;

167 return projectName;

168}

References Config_getString and QCString::isEmpty.

Referenced by Qhp::initialize.

makeFileName()

QCString makeFileName (const QCString & withoutExtension)

static

Definition at line 170 of file qhp.cpp.

170static QCString makeFileName(const QCString & withoutExtension)

171{

172 QCString result=withoutExtension;

173 if (!result.isEmpty())

174 {

175 if (result.at(0)=='!') // relative URL -> strip marker

176 {

177 result=result.mid(1);

178 }

179 else // add specified HTML extension

180 {

181 addHtmlExtensionIfMissing(result);

182 }

183 }

184 return result;

185}

References addHtmlExtensionIfMissing, QCString::at, QCString::isEmpty and QCString::mid.

Referenced by makeRef.

makeRef()

QCString makeRef (const QCString & withoutExtension, const QCString & anchor)

static

Definition at line 187 of file qhp.cpp.

187static QCString makeRef(const QCString & withoutExtension, const QCString & anchor)

188{

189 //printf("QHP::makeRef(%s,%s)\n",withoutExtension,anchor);

190 if (withoutExtension.isEmpty()) return QCString();

191 QCString result = makeFileName(withoutExtension);

192 if (anchor.isEmpty()) return result;

193 return result+"#"+anchor;

194}

References QCString::isEmpty and makeFileName.

Referenced by Qhp::addContentsItem, Crawlmap::addIndexItem and Qhp::addIndexItem.

writeIndent()

void writeIndent (TextStream & t, int indent)

inline static

Definition at line 37 of file qhp.cpp.

37static inline void writeIndent(TextStream &t,int indent)

38{

39 if (Debug::isFlagSet(Debug::Qhp))

40 {

41 for (int i=0;i<indent;i++) t << " ";

42 }

43}

References Debug::isFlagSet and Debug::Qhp.

Referenced by Qhp::addIndexItem, Qhp::finalize, generateXMLForPage, Qhp::initialize, QhpSectionTree::traverse and QhpSectionTree::writeToc.

Variables

g_blankWritten

std::once_flag g_blankWritten

static

Definition at line 34 of file qhp.cpp.

34static std::once_flag g_blankWritten;

Referenced by Qhp::addContentsItem.

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.