The message.h File Reference

Included Headers

#include <fmt/core.h> #include <fmt/compile.h> #include "types.h" #include "qcstring.h"

Namespaces Index

namespace	fmt

Classes Index

struct	formatter<T>
struct	formatter<QCString>
	adds support for formatting QCString More...
struct	formatter<Protection>
	adds support for formatting Protected More...
struct	formatter<Specifier>
	adds support for formatting Specifier More...
struct	formatter<MethodTypes>
	adds support for formatting MethodTypes More...
struct	formatter<RelatesType>
	adds support for formatting RelatesType More...
struct	formatter<Relationship>
	adds support for formatting RelationShip More...
struct	formatter<SrcLangExt>
	adds support for formatting SrcLangExt More...
struct	formatter<MemberType>
	adds support for formatting MemberType More...
struct	formatter<TypeSpecifier>
	adds support for formatting TypeSpecifier More...
struct	formatter<EntryType>
	adds support for formatting EntryType More...
struct	formatter<MemberListType>
	adds support for formatting MemberListType More...

Enumerations Index

enum class	WarningType { ... }

Functions Index

void	msg_ (fmt::string_view fmt, fmt::format_args args)
void	warn_ (WarningType type, const QCString &file, int line, fmt::string_view fmt, fmt::format_args args)
void	warn_uncond_ (fmt::string_view fmt, fmt::format_args args)
void	err_ (fmt::string_view fmt, fmt::format_args args)
void	err_full_ (const QCString &file, int line, fmt::string_view fmt, fmt::format_args args)
void	term_ (fmt::string_view fmt, fmt::format_args args)
QCString	warn_line (const QCString &file, int line)
void	initWarningFormat ()
void	warn_flush ()
void	finishWarnExit ()
template <typename ... Args>
void	err_fmt (fmt::format_string< Args... > fmt, Args &&... args)
template <typename ... Args>
void	err_full_fmt (const QCString &file, int line, fmt::format_string< Args... > fmt, Args &&... args)
template <typename ... Args>
void	term_fmt (fmt::format_string< Args... > fmt, Args &&... args)
template <typename ... Args>
void	msg_fmt (fmt::format_string< Args... > fmt, Args &&... args)
template <typename ... Args>
void	warn_fmt (WarningType type, const QCString &file, int line, fmt::format_string< Args... > fmt, Args &&... args)
template <typename ... Args>
void	warn_uncond_fmt (fmt::format_string< Args... > fmt, Args &&... args)
template <std::size_t N>
constexpr bool	has_newline_at_end (const char(&str)[N])

Macro Definitions Index

#define	msg_no_newline_allowed(x)    static_assert(!has_newline_at_end(x),"text: \"" x "\" should not have \\n at end");
#define	msg_newline_required(x)    static_assert(has_newline_at_end(x),"text: \"" x "\" should have \\n at end");
#define	msg(fmt, ...)    msg_fmt(FMT_STRING(fmt),##__VA_ARGS__)
#define	warn(file, line, fmt, ...)   ...
#define	warn_undoc(file, line, fmt, ...)   ...
#define	warn_incomplete_doc(file, line, fmt, ...)   ...
#define	warn_doc_error(file, line, fmt, ...)   ...
#define	warn_layout(file, line, fmt, ...)   ...
#define	warn_uncond(fmt, ...)   ...
#define	err(fmt, ...)   ...
#define	err_full(file, line, fmt, ...)   ...
#define	term(fmt, ...)   ...

Enumerations

WarningType

enum class WarningType

strong

Enumeration values

Generic
Undocumented
IncompleteDoc
DocError
Layout

Definition at line 25 of file message.h.

26{

27 Generic,

28 Undocumented,

29 IncompleteDoc,

30 DocError,

31 Layout

32};

Functions

err_()

void err_ (fmt::string_view fmt, fmt::format_args args)

Declaration at line 37 of file message.h, definition at line 175 of file message.cpp.

175void err_(fmt::string_view fmt, fmt::format_args args)

176{

177 {

178 std::unique_lock<std::mutex> lock(g_mutex);

179 if (checkWarnMessage(g_errorStr+fmt::vformat(fmt,args))) fmt::print(g_warnFile,"{}{}",g_errorStr,fmt::vformat(fmt,args));

180 }

181 handle_warn_as_error();

182}

References checkWarnMessage, g_errorStr, g_mutex, g_warnFile and handle_warn_as_error.

Referenced by err_fmt.

err_fmt()

template <typename ... Args>

void err_fmt (fmt::format_string< Args... > fmt, Args &&... args)

Definition at line 46 of file message.h.

46void err_fmt(fmt::format_string<Args...> fmt, Args&&... args)

47{

48 err_(fmt,fmt::make_format_args(args...));

49}

Reference err_.

err_full_()

void err_full_ (const QCString & file, int line, fmt::string_view fmt, fmt::format_args args)

Declaration at line 38 of file message.h, definition at line 186 of file message.cpp.

186void err_full_(const QCString &file, int line, fmt::string_view fmt, fmt::format_args args)

187{

188 format_warn(file,line,QCString(g_errorStr+fmt::vformat(fmt,args)));

189}

References format_warn and g_errorStr.

Referenced by err_full_fmt.

err_full_fmt()

template <typename ... Args>

void err_full_fmt (const QCString & file, int line, fmt::format_string< Args... > fmt, Args &&... args)

Definition at line 52 of file message.h.

52void err_full_fmt(const QCString &file, int line, fmt::format_string<Args...> fmt,Args&&... args)

53{

54 err_full_(file,line,fmt,fmt::make_format_args(args...));

55}

Reference err_full_.

finishWarnExit()

void finishWarnExit ()

Declaration at line 43 of file message.h, definition at line 295 of file message.cpp.

295void finishWarnExit()

296{

297 fflush(stdout);

298 if (g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS_PRINT && g_warnlogFile != "-")

299 {

300 Portable::fclose(g_warnFile);

301 g_warnFile = nullptr;

302 }

303 if (g_warnStat && g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS_PRINT && g_warnlogFile != "-")

304 {

305

306 std::ifstream warnFile = Portable::openInputStream(g_warnlogFile);

307 if (!warnFile.is_open())

308 {

309 g_warnFile = stderr;

310 err("Cannot open warnings file '{}' for reading\n",g_warnlogFile);

311 }

312 else

313 {

314 std::string line;

315 while (getline(warnFile,line))

316 {

317 fmt::print(stderr,"{}\n",line);

318 }

319 warnFile.close();

320 }

321 }

322

323 if (g_warnlogTemp) Portable::unlink(g_warnlogFile);

324

325 if (g_warnStat && (g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS ||

326 g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS_PRINT))

327 {

328 exit(1);

329 }

330}

References err, Portable::fclose, g_warnBehavior, g_warnFile, g_warnlogFile, g_warnlogTemp, g_warnStat, Portable::openInputStream and Portable::unlink.

Referenced by generateOutput.

has_newline_at_end()

template <std::size_t N>

bool has_newline_at_end (const char(&) str=[N])

constexpr

Definition at line 83 of file message.h.

83constexpr bool has_newline_at_end(const char (&str)[N])

84{

85 return str[N-2]=='\n';

86}

initWarningFormat()

void initWarningFormat ()

Declaration at line 41 of file message.h, definition at line 237 of file message.cpp.

237void initWarningFormat()

238{

239 g_warnFormat = Config_getString(WARN_FORMAT);

240 g_warnLineFormat = Config_getString(WARN_LINE_FORMAT);

241 g_warnBehavior = Config_getEnum(WARN_AS_ERROR);

242 g_warnlogFile = Config_getString(WARN_LOGFILE);

243 if (g_warnlogFile.isEmpty() && g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS_PRINT)

244 {

245 uint32_t pid = Portable::pid();

246 g_warnlogFile.sprintf("doxygen_warnings_temp_%d.tmp",pid);

247 g_warnlogTemp = true;

248 }

249

250 if (!g_warnlogFile.isEmpty())

251 {

252 if (g_warnlogFile == "-")

253 {

254 g_warnFile = stdout;

255 }

256 else

257 {

258 FileInfo fi(g_warnlogFile.str());

259 Dir d(fi.dirPath().c_str());

260 if (!d.exists() && !d.mkdir(fi.dirPath().c_str()))

261 {

262 // point it to something valid, because warn() relies on it

263 g_warnFile = stderr;

264 err("Cannot create directory for '{}', redirecting 'WARN_LOGFILE' output to 'stderr'\n",g_warnlogFile);

265 }

266 else if (!(g_warnFile = Portable::fopen(g_warnlogFile,"w")))

267 {

268 // point it to something valid, because warn() relies on it

269 g_warnFile = stderr;

270 err("Cannot open '{}' for writing, redirecting 'WARN_LOGFILE' output to 'stderr'\n",g_warnlogFile);

271 }

272 }

273 }

274 else

275 {

276 g_warnFile = stderr;

277 }

278 if (g_warnBehavior != WARN_AS_ERROR_t::NO)

279 {

280 g_warningStr = g_errorStr;

281 }

282

283 // make sure the g_warnFile is closed in case we call exit and it is still open

284 std::atexit([](){

285 if (g_warnFile && g_warnFile!=stderr && g_warnFile!=stdout)

286 {

287 Portable::fclose(g_warnFile);

288 g_warnFile = nullptr;

289 }

290 });

291}

References Config_getEnum, Config_getString, FileInfo::dirPath, err, Dir::exists, Portable::fclose, Portable::fopen, g_errorStr, g_warnBehavior, g_warnFile, g_warnFormat, g_warningStr, g_warnLineFormat, g_warnlogFile, g_warnlogTemp, Dir::mkdir and Portable::pid.

Referenced by checkConfiguration.

msg_()

void msg_ (fmt::string_view fmt, fmt::format_args args)

Declaration at line 34 of file message.h, definition at line 130 of file message.cpp.

130void msg_(fmt::string_view fmt, fmt::format_args args)

131{

132 if (!Config_getBool(QUIET))

133 {

134 std::unique_lock<std::mutex> lock(g_mutex);

135 if (Debug::isFlagSet(Debug::Time))

136 {

137 fmt::print("{:.3f} sec: ",(static_cast<double>(Debug::elapsedTime())));

138 }

139 fmt::print("{}",fmt::vformat(fmt,args));

140 }

141}

References Config_getBool, Debug::elapsedTime, g_mutex, Debug::isFlagSet and Debug::Time.

Referenced by msg_fmt.

msg_fmt()

template <typename ... Args>

void msg_fmt (fmt::format_string< Args... > fmt, Args &&... args)

Definition at line 64 of file message.h.

64void msg_fmt(fmt::format_string<Args...> fmt, Args&&... args)

65{

66 msg_(fmt,fmt::make_format_args(args...));

67}

Reference msg_.

term_()

void term_ (fmt::string_view fmt, fmt::format_args args)

Declaration at line 39 of file message.h, definition at line 193 of file message.cpp.

193void term_(fmt::string_view fmt, fmt::format_args args)

194{

195 {

196 std::unique_lock<std::mutex> lock(g_mutex);

197 if (checkWarnMessage(g_errorStr+fmt::vformat(fmt,args))) fmt::print(g_warnFile, "{}{}", g_errorStr, fmt::vformat(fmt,args));

198 if (g_warnFile != stderr)

199 {

200 size_t l = strlen(g_errorStr);

201 for (size_t i=0; i<l; i++) fmt::print(g_warnFile, " ");

202 fmt::print(g_warnFile, "{}\n", "Exiting...");

203 if (!Config_getBool(QUIET))

204 {

205 // cannot use `msg` due to the mutex

206 fmt::print("See '{}' for the reason of termination.\n",g_warnlogFile);

207 }

208 }

209 }

210 exit(1);

211}

References checkWarnMessage, Config_getBool, g_errorStr, g_mutex, g_warnFile and g_warnlogFile.

Referenced by term_fmt.

term_fmt()

template <typename ... Args>

void term_fmt (fmt::format_string< Args... > fmt, Args &&... args)

Definition at line 58 of file message.h.

58void term_fmt(fmt::format_string<Args...> fmt, Args&&... args)

59{

60 term_(fmt,fmt::make_format_args(args...));

61}

Reference term_.

warn_()

void warn_ (WarningType type, const QCString & file, int line, fmt::string_view fmt, fmt::format_args args)

Declaration at line 35 of file message.h, definition at line 145 of file message.cpp.

145void warn_(WarningType type, const QCString &file, int line, fmt::string_view fmt, fmt::format_args args)

146{

147 bool enabled = false;

148 switch (type)

149 {

150 case WarningType::Generic: enabled = Config_getBool(WARNINGS); break;

151 case WarningType::Undocumented: enabled = Config_getBool(WARN_IF_UNDOCUMENTED); break;

152 case WarningType::IncompleteDoc: enabled = Config_getBool(WARN_IF_INCOMPLETE_DOC); break;

153 case WarningType::DocError: enabled = Config_getBool(WARN_IF_DOC_ERROR); break;

154 case WarningType::Layout: enabled = Config_getBool(WARN_LAYOUT_FILE); break;

155 }

156 if (enabled)

157 {

158 do_warn(file, line, g_warningStr, fmt, args);

159 }

160}

References Config_getBool, do_warn, DocError, g_warningStr, Generic, IncompleteDoc, Layout and Undocumented.

Referenced by warn_fmt.

warn_flush()

void warn_flush ()

Declaration at line 42 of file message.h, definition at line 230 of file message.cpp.

230void warn_flush()

231{

232 fflush(g_warnFile);

233}

Reference g_warnFile.

Referenced by Statistics::end.

warn_fmt()

template <typename ... Args>

void warn_fmt (WarningType type, const QCString & file, int line, fmt::format_string< Args... > fmt, Args &&... args)

Definition at line 70 of file message.h.

70void warn_fmt(WarningType type, const QCString &file, int line, fmt::format_string<Args...> fmt,Args&&... args)

71{

72 warn_(type,file,line,fmt,fmt::make_format_args(args...));

73}

Reference warn_.

warn_line()

QCString warn_line (const QCString & file, int line)

Declaration at line 40 of file message.h, definition at line 215 of file message.cpp.

215QCString warn_line(const QCString &file,int line)

216{

217 QCString fileSubst = file.isEmpty() ? "<unknown>" : file;

218 QCString lineSubst; lineSubst.setNum(line);

219 return substitute(

220 substitute(

221 g_warnLineFormat,

222 "$file",fileSubst

223 ),

224 "$line",lineSubst

225 );

226}

References g_warnLineFormat, QCString::isEmpty, QCString::setNum and substitute.

Referenced by addMemberFunction, checkPageRelations, computePageRelations and findGlobalMember.

warn_uncond_()

void warn_uncond_ (fmt::string_view fmt, fmt::format_args args)

Declaration at line 36 of file message.h, definition at line 164 of file message.cpp.

164void warn_uncond_(fmt::string_view fmt, fmt::format_args args)

165{

166 {

167 std::unique_lock<std::mutex> lock(g_mutex);

168 if (checkWarnMessage(g_errorStr+fmt::vformat(fmt,args))) fmt::print(g_warnFile,"{}{}",g_warningStr,vformat(fmt,args));

169 }

170 handle_warn_as_error();

171}

References checkWarnMessage, g_errorStr, g_mutex, g_warnFile, g_warningStr and handle_warn_as_error.

Referenced by warn_uncond_fmt.

warn_uncond_fmt()

template <typename ... Args>

void warn_uncond_fmt (fmt::format_string< Args... > fmt, Args &&... args)

Definition at line 76 of file message.h.

76void warn_uncond_fmt(fmt::format_string<Args...> fmt,Args&&... args)

77{

78 warn_uncond_(fmt,fmt::make_format_args(args...));

79}

Reference warn_uncond_.

Macro Definitions

err

#define err(fmt, ...)   ...

Value

do { \ msg_newline_required(fmt); \ err_fmt(FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 127 of file message.h.

127#define err(fmt,...) do { \

128 msg_newline_required(fmt); \

129 err_fmt(FMT_STRING(fmt),##__VA_ARGS__); \

130 } while (0)

Referenced by MemberDefImpl::_writeReimplements, FileDefImpl::acquireFileVersion, DefinitionImpl::addInnerCompound, addValidAliasToMap, adjustBoolSetting, adjustColorStyleSetting, adjustConfiguration, adjustStringSetting, RTFGenerator::beginRTFDocument, bindIntParameter, bindTextParameter, Config::checkAndCorrect, checkFileName, checkList, checkPngResult, classInheritedProtectionLevel, convertMapFile, DotFilePatcher::convertMapFile, copyExtraFiles, copyFile, copyIcon, copyLatexStyleSheet, copyLogo, ResourceMgr::copyResourceAs, copyStyleSheet, MemberList::countDecMembers, createCroppedEPS, createCroppedPDF, createDVIFile, createEPSbboxFile, PerlModGenerator::createOutputDir, PerlModGenerator::createOutputFile, createPNG, createPostscriptFile, HtmlHelp::Private::createProjectFile, DotManager::createRunner, FlowChart::createSVG, createSVGFromPDF, createSVGFromPDFviaInkscape, RTFGenerator::decIndentLevel, NamespaceLinkedRefMap::declVisible, elemIsVisible, Htags::execute, extractBoundingBox, fileToString, DocParser::findAndCopyImage, FlowChart::findLabel, finishWarnExit, generateDEF, generateFormula, generateOutput, CitationManager::generatePage, generateSqlite3, generateXML, generateXMLForClass, generateXMLForConcept, generateXMLForDir, generateXMLForFile, generateXMLForGroup, generateXMLForModule, generateXMLForNamespace, generateXMLForPage, FilterCache::getFileContentsPipe, DocPara::handleShowDate, hasNonReferenceNestedGroupRec, hasNonReferenceNestedNamespaceRec, hasNonReferenceSuperClassRec, LatexDocVisitor::incIndentLevel, RTFDocVisitor::incIndentLevel, RTFGenerator::incIndentLevel, RTFGenerator::init, initializeTables, initializeViews, initWarningFormat, CitationManager::insertCrossReferencesForBibFile, FileDefImpl::insertMember, GroupDefImpl::insertMember, NamespaceDefImpl::insertMember, ClassDefImpl::internalInsertMember, ClassDefImpl::isBaseClass, ClassDefImpl::isSubClass, VhdlDocGen::isSubClass, loadExtensions, Htags::loadFilemap, loadStylesheet, openDbConnection, DocbookDocVisitor::operator(), DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator(), PerlModDocVisitor::operator(), PerlModDocVisitor::operator(), PerlModDocVisitor::operator(), RTFDocVisitor::operator(), RTFDocVisitor::operator(), TextDocVisitor::operator(), XmlDocVisitor::operator(), DotGraph::prepareDotFile, prepareStatement, preProcessFile, RTFGenerator::preProcessFileInplace, DotRunner::readBoundingBox, readCodeFragment, readConfiguration, readInputFile, readTagFile, readTextFileByName, FileDefImpl::removeMember, GroupDefImpl::removeMember, replaceVariables, resetPDFSize, DotFilePatcher::run, runHtmlHelpCompiler, runQHelpGenerator, StyleData::setStyle, showDate, SysTimeKeeper::stop, testRTFOutput, updateEPSBoundingBox, updateLanguageMapping, SearchIndexExternal::write, ResourceMgr::writeCategory, writeCombineScript, MemberDefImpl::writeDeclaration, writeDefaultLayoutFile, FileDefImpl::writeDetailedDescription, writeDiaGraphFromFile, ConceptDefImpl::writeDocumentation, DirDefImpl::writeDocumentation, FileDefImpl::writeDocumentation, GroupDefImpl::writeDocumentation, MemberList::writeDocumentation, ModuleDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, ClassDefImpl::writeDocumentationContents, HtmlGenerator::writeExternalSearchPage, ClassDiagram::writeFigure, FlowChart::writeFlowChart, writeJavasScriptSearchDataPage, MemberList::writePlainDeclarations, HtmlGenerator::writeSearchPage, DefinitionImpl::writeSourceDef, HtmlGenerator::writeStyleInfo and writeTagFile.

err_full

#define err_full(file, line, fmt, ...)   ...

Value

do { \ msg_no_newline_allowed(fmt); \ err_full_fmt(file,line,FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 132 of file message.h.

132#define err_full(file,line,fmt,...) do { \

133 msg_no_newline_allowed(fmt); \

134 err_full_fmt(file,line,FMT_STRING(fmt),##__VA_ARGS__); \

135 } while (0)

Referenced by NamespaceDefImpl::compoundTypeString, do_mscgen_generate, DotRunner::run, runPlantumlContent, writeDiaGraphFromFile and writeMscGraphFromFile.

msg

#define msg(fmt, ...)    msg_fmt(FMT_STRING(fmt),##__VA_ARGS__)

Definition at line 94 of file message.h.

94#define msg(fmt,...) \

95 msg_fmt(FMT_STRING(fmt),##__VA_ARGS__)

Referenced by MemberDefImpl::_writeCallerGraph, MemberDefImpl::_writeCallGraph, FileDefImpl::acquireFileVersion, adjustConfiguration, Statistics::begin, checkAndUpdatePath, devUsage, anonymous{tagreader.cpp}::TagFileParser::error, LayoutParser::error, exitDoxygen, format_warn, generateConceptDocs, generateConfigFile, generateDocsForClassList, generateExampleDocs, generateFileDocs, generateFileSources, generateFormula, generateNamespaceClassDocs, generateNamespaceConceptDocs, generateNamespaceDocs, generateOutput, generatePageDocs, generateSqlite3, generateXML, generateXMLForClass, LayoutDocManager::init, FormulaManager::initFromRepository, initializeTables, initializeViews, loadExtensions, loadStylesheet, LayoutDocManager::parse, XMLParser::parse, parseFile, parseFilesMultiThreading, parseInput, VHDLOutlineParser::parseInput, parseMain, parseMain, parseMain, parseMain, parseTagFile, Statistics::print, Debug::printFlags, processData, readConfiguration, readDir, readIncludeFile, readTagFile, reportError, DotManager::run, runPlantumlContent, AutoTrace::setExit, setTranslator, stopDoxygen, LayoutNavEntry::url, usage, version, DirDefImpl::writeDirectoryGraph, ClassDefImpl::writeDocumentationForInnerClasses, GroupDefImpl::writeGroupGraph, writeIndex and writeIndexHierarchyEntries.

msg_newline_required

#define msg_newline_required(x)    static_assert(has_newline_at_end(x),"text: \"" x "\" should have \\n at end");

Definition at line 91 of file message.h.

91#define msg_newline_required(x) \

92 static_assert(has_newline_at_end(x),"text: \"" x "\" should have \\n at end");

msg_no_newline_allowed

#define msg_no_newline_allowed(x)    static_assert(!has_newline_at_end(x),"text: \"" x "\" should not have \\n at end");

Definition at line 88 of file message.h.

88#define msg_no_newline_allowed(x) \

89 static_assert(!has_newline_at_end(x),"text: \"" x "\" should not have \\n at end");

term

#define term(fmt, ...)   ...

Value

do { \ msg_newline_required(fmt); \ term_fmt(FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 137 of file message.h.

137#define term(fmt,...) do { \

138 msg_newline_required(fmt); \

139 term_fmt(FMT_STRING(fmt),##__VA_ARGS__); \

140 } while (0)

Referenced by SearchIndexInfo::add, Qhp::addContentsItem, addTillEndOfString, adjustConfiguration, checkPageRelations, compareDoxyfile, computePageRelations, createOutputDirectory, createSubDirs, generateConfigFile, FormulaManager::generateImages, generateOutput, DocbookGenerator::init, HtmlGenerator::init, LatexGenerator::init, ManGenerator::init, RTFGenerator::init, Crawlmap::initialize, DocSets::initialize, EclipseHelp::initialize, HtmlHelp::initialize, HtmlHelpRecoder::initialize, Qhp::initialize, Sitemap::initialize, parseInput, DotGraph::prepareDotFile, processUntilMatchingTerminator, OutputGenerator::startPlainFile, transcodeCharacterBuffer, writeDotGraphFromFile, writeDotImageMapFromFile, ClassDiagram::writeFigure, DotGfxHierarchyTable::writeGraph, writeJavasScriptSearchDataPage, writeLatexMakefile and writeMakeBat.

warn

#define warn(file, line, fmt, ...)   ...

Value

do { \ msg_no_newline_allowed(fmt); \ warn_fmt(WarningType::Generic,file,line,FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 97 of file message.h.

97#define warn(file,line,fmt,...) do { \

98 msg_no_newline_allowed(fmt); \

99 warn_fmt(WarningType::Generic,file,line,FMT_STRING(fmt),##__VA_ARGS__); \

100 } while (0)

Referenced by addAnchor, addClassToGroups, addConceptToGroups, addDirToGroups, ModuleManager::addDocs, addExampleToGroups, addGroupToGroups, addIncludeFile, addMemberDocs, addMemberFunction, addMemberToGroups, addModuleToGroups, addNamespaceToGroups, addRelatedPage, addSection, addXRefItem, buildExampleList, buildFileList, buildFunctionList, buildGroupListFiltered, buildInterfaceAndServiceList, checkBlocks, checkFormula, DocGroup::close, convertCppComments, decrLevel, endCondSection, endCondSection, DocGroup::enterCompound, anonymous{tagreader.cpp}::TagFileParser::error, Markdown::Private::extractTitleId, findClassRelation, findDefineDocumentation, findDirDocumentation, findEnumDocumentation, findGlobalMember, findMainPage, findMember, getConvertLatexMacro, MemberDefImpl::getOutputFileBase, DocPara::handleCite, DocPara::handleCommand, DocPara::handleDoxyConfig, handleElse, handleElseIf, handleEndIf, handleEndParBlock, handleExample, handleFileInfoResult, handleInheritanceGraph, handleMemberOf, vhdl::parser::VhdlErrorHandler::handleOtherError, handleParBlock, vhdl::parser::VhdlErrorHandler::handleParseError, handleRelated, handleRelatedAlso, handleSubpage, handleToc, vhdl::parser::VhdlErrorHandler::handleUnexpectedToken, CitationManager::insertCrossReferencesForBibFile, ClassDefImpl::internalInsertMember, DocGroup::leaveFile, vhdl::parser::VhdlTokenManagerErrorHandler::lexicalError, vhdl::parser::VhdlTokenManagerErrorHandler::lexicalError, loadExtensions, loadStylesheet, otherCaseDone, CondParser::parse, CommentScanner::parseCommentBlock, parseIncludeOptions, parseMain, parsePrototype, parsePrototype, pop_state, pop_state, pop_state, Preprocessor::processFile, processSection, readIncludeFile, resolveClassNestingRelations, subrHandleCommentBlock, substituteKeywords, tryAddEnumDocsToGroupMember, MemberDefImpl::virtualness, MemberDefImpl::warnIfUndocumented, writeDirTreeNode, writeExceptionListImpl and writeGroupTreeNode.

warn_doc_error

#define warn_doc_error(file, line, fmt, ...)   ...

Value

do { \ msg_no_newline_allowed(fmt); \ warn_fmt(WarningType::DocError,file,line,FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 112 of file message.h.

112#define warn_doc_error(file,line,fmt,...) do { \

113 msg_no_newline_allowed(fmt); \

114 warn_fmt(WarningType::DocError,file,line,FMT_STRING(fmt),##__VA_ARGS__); \

115 } while (0)

Referenced by DocParser::checkArgumentName, DocParser::checkRetvalName, DocParser::checkUnOrMultipleDocumentedParams, DocParser::defaultHandleToken, DocAnchor::DocAnchor, DocCite::DocCite, DocEmoji::DocEmoji, DocFormula::DocFormula, DocHtmlCaption::DocHtmlCaption, DocRef::DocRef, DocParser::errorHandleDefaultToken, DocParser::findAndCopyImage, DocParser::handleAHref, DocParser::handleAnchor, DocPara::handleCite, DocPara::handleCommand, DocPara::handleDoxyConfig, DocPara::handleEmoji, DocPara::handleFile, DocPara::handleHtmlEndTag, DocPara::handleHtmlStartTag, DocPara::handleIFile, DocPara::handleILine, DocParser::handleImage, DocParser::handleImg, DocPara::handleInclude, DocPara::handleIncludeOperator, DocParser::handleInternalRef, DocPara::handleLink, DocParser::handleLinkedWord, DocParser::handlePrefix, DocPara::handleRef, DocPara::handleSection, DocPara::handleShowDate, DocPara::handleStartCode, DocParser::handleStyleArgument, DocParser::handleStyleLeave, DocParser::handleUnclosedStyleCommands, DocDiaFile::parse, DocDotFile::parse, DocHRef::parse, DocHtmlBlockQuote::parse, DocHtmlCaption::parse, DocHtmlDescList::parse, DocHtmlDescTitle::parse, DocHtmlDetails::parse, DocHtmlHeader::parse, DocHtmlList::parse, DocHtmlRow::parse, DocHtmlSummary::parse, DocHtmlTable::parse, DocInclude::parse, DocIncOperator::parse, DocIndexEntry::parse, DocInternal::parse, DocLink::parse, DocMscFile::parse, DocPara::parse, DocParamList::parse, DocPlantUmlFile::parse, DocRef::parse, DocRoot::parse, DocSecRefItem::parse, DocSecRefList::parse, DocSection::parse, DocText::parse, DocHtmlList::parseXml, DocHtmlRow::parseXml, DocParamList::parseXml, DocParser::processCopyDoc, readIncludeFile, DocParser::readTextFileByName and MemberDefImpl::warnIfUndocumentedParams.

warn_incomplete_doc

#define warn_incomplete_doc(file, line, fmt, ...)   ...

Value

do { \ msg_no_newline_allowed(fmt); \ warn_fmt(WarningType::IncompleteDoc,file,line,FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 107 of file message.h.

107#define warn_incomplete_doc(file,line,fmt,...) do { \

108 msg_no_newline_allowed(fmt); \

109 warn_fmt(WarningType::IncompleteDoc,file,line,FMT_STRING(fmt),##__VA_ARGS__); \

110 } while (0)

Referenced by DocParser::checkUnOrMultipleDocumentedParams.

warn_layout

#define warn_layout(file, line, fmt, ...)   ...

Value

do { \ msg_no_newline_allowed(fmt); \ warn_fmt(WarningType::Layout,file,line,FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 117 of file message.h.

117#define warn_layout(file,line,fmt,...) do { \

118 msg_no_newline_allowed(fmt); \

119 warn_fmt(WarningType::Layout,file,line,FMT_STRING(fmt),##__VA_ARGS__); \

120 } while (0)

Referenced by LayoutParser::error, mergeDocEntryLists, LayoutParser::startElement and LayoutParser::startNavEntry.

warn_uncond

#define warn_uncond(fmt, ...)   ...

Value

do { \ msg_newline_required(fmt); \ warn_uncond_fmt(FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 122 of file message.h.

122#define warn_uncond(fmt,...) do { \

123 msg_newline_required(fmt); \

124 warn_uncond_fmt(FMT_STRING(fmt),##__VA_ARGS__); \

125 } while (0)

Referenced by MemberDefImpl::_writeCallerGraph, MemberDefImpl::_writeCallGraph, Config::checkAndCorrect, checkMarkdownMainfile, computeVerifiedDotPath, getCurrentDateTime, FormulaManager::initFromRepository, minClassDistance, parseInput, readDir, readFileOrDirectory, searchInputFiles, Config::updateObsolete, HtmlEntityMapper::validate, ClassDefImpl::writeCollaborationGraph, GroupDefImpl::writeGroupGraph, FileDefImpl::writeIncludedByGraph, FileDefImpl::writeIncludeGraph and ClassDefImpl::writeInheritanceGraph.

warn_undoc

#define warn_undoc(file, line, fmt, ...)   ...

Value

do { \ msg_no_newline_allowed(fmt); \ warn_fmt(WarningType::Undocumented,file,line,FMT_STRING(fmt),##__VA_ARGS__); \ } while (0)

Definition at line 102 of file message.h.

102#define warn_undoc(file,line,fmt,...) do { \

103 msg_no_newline_allowed(fmt); \

104 warn_fmt(WarningType::Undocumented,file,line,FMT_STRING(fmt),##__VA_ARGS__); \

105 } while (0)

Referenced by computeClassRelations, findMember, MemberDefImpl::warnIfUndocumented and warnUndocumentedNamespaces.

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.