manifestwriter.cpp File Reference

(74f31ce5ad6beff8052be97b52a4e1c311b86873)

#include "manifestwriter.h"
#include "config.h"
#include "examplenode.h"
#include "generator.h"
#include "location.h"
#include "outputdirectory.h"
#include "qdocdatabase.h"
#include <QtCore/qmap.h>
#include <QtCore/qset.h>
#include <QtCore/qxmlstream.h>

Include dependency graph for manifestwriter.cpp:

Go to the source code of this file.

Functions
void	warnAboutUnusedAttributes (const QStringList &usedAttributes, const ExampleNode *example)
void	writeDescription (QXmlStreamWriter *writer, const ExampleNode *example)
	command. If no brief is available, the element is set to "No description available".
QMap< int, QString >	getFilesToOpen (const QStringList &files, const QString &exampleName)
void	writeFilesToOpen (QXmlStreamWriter &writer, const QString &installPath, const QMap< int, QString > &filesToOpen)
	Writes the lists of files to open for the example.
static void	writeMetaInformation (QXmlStreamWriter &writer, const QStringMultiMap &map)
	Writes example metadata into writer.
static QString	moduleNameAsTag (const QString &module)
static QSet< QString >	tagsAddedWithMetaCommand (const ExampleNode *example)
static void	writeTagsElement (QXmlStreamWriter *writer, const QSet< QString > &tags)

Function Documentation

getFilesToOpen()

QMap< int, QString > getFilesToOpen	(	const QStringList &	files,
		const QString &	exampleName )

Returns a list of files that Qt Creator should open for the exampleName.

Definition at line 74 of file manifestwriter.cpp.

moduleNameAsTag()

QString moduleNameAsTag ( const QString & module )

static

Definition at line 217 of file manifestwriter.cpp.

tagsAddedWithMetaCommand()

QSet< QString > tagsAddedWithMetaCommand ( const ExampleNode * example )

static

Definition at line 235 of file manifestwriter.cpp.

References Node< _Tp >::doc().

Here is the call graph for this function:

warnAboutUnusedAttributes()

void warnAboutUnusedAttributes	(	const QStringList &	usedAttributes,
		const ExampleNode *	example )

For each attribute in a map of attributes, checks if the attribute is found in usedAttributes. If it is not found, issues a warning specific to the attribute.

Definition at line 27 of file manifestwriter.cpp.

References Node< _Tp >::doc().

Here is the call graph for this function:

writeDescription()

void writeDescription	(	QXmlStreamWriter *	writer,
		const ExampleNode *	example )

command. If no brief is available, the element is set to "No description available".

Write the description element. The description for an example is set with the

Definition at line 57 of file manifestwriter.cpp.

References Node< _Tp >::doc(), and Text::isEmpty().

Here is the call graph for this function:

writeFilesToOpen()

void writeFilesToOpen	(	QXmlStreamWriter &	writer,
		const QString &	installPath,
		const QMap< int, QString > &	filesToOpen )

Writes the lists of files to open for the example.

Writes out the filesToOpen and the full installPath through writer.

Definition at line 109 of file manifestwriter.cpp.

writeMetaInformation()

void writeMetaInformation ( QXmlStreamWriter & writer, const QStringMultiMap & map )

static

Writes example metadata into writer.

For instance,

\ meta category {Application Example}

becomes

<meta> <entry name="category">Application Example</entry> <meta>

Definition at line 137 of file manifestwriter.cpp.

writeTagsElement()

void writeTagsElement ( QXmlStreamWriter * writer, const QSet< QString > & tags )

static

Definition at line 256 of file manifestwriter.cpp.