Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include "manifestwriter.h"
#include "config.h"
#include "examplenode.h"
#include "generator.h"
#include "qdocdatabase.h"
#include <QtCore/qmap.h>
#include <QtCore/qset.h>
#include <QtCore/qxmlstream.h>
Go to the source code of this file.
Functions | |
QT_BEGIN_NAMESPACE 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) |
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 70 of file manifestwriter.cpp.
Definition at line 213 of file manifestwriter.cpp.
|
static |
Definition at line 231 of file manifestwriter.cpp.
References Node< _Tp >::doc().
QT_BEGIN_NAMESPACE 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 23 of file manifestwriter.cpp.
References Node< _Tp >::doc().
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 53 of file manifestwriter.cpp.
References Node< _Tp >::doc(), and Text::isEmpty().
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 105 of file manifestwriter.cpp.
|
static |
Writes example metadata into writer.
For instance,
\ meta category {Application Example}
becomes
<meta> <entry name="category">Application Example</entry> <meta>
Definition at line 133 of file manifestwriter.cpp.
Definition at line 252 of file manifestwriter.cpp.