Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
sharedcommentnode.h
Go to the documentation of this file.
1// Copyright (C) 2021 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3
4#ifndef SHAREDCOMMENTNODE_H
5#define SHAREDCOMMENTNODE_H
6
7#include "node.h"
8
9#include <QtCore/qglobal.h>
10#include <QtCore/qlist.h>
11
13
14class Aggregate;
15class QmlTypeNode;
16
17class SharedCommentNode : public Node
18{
19public:
20 explicit SharedCommentNode(Node *node) : Node(Node::SharedComment, node->parent(), QString())
21 {
22 m_collective.reserve(1);
23 append(node);
24 }
25 SharedCommentNode(QmlTypeNode *parent, int count, QString &group);
26 ~SharedCommentNode() override { m_collective.clear(); }
27
28 [[nodiscard]] bool isPropertyGroup() const override
29 {
30 return !name().isEmpty() && !m_collective.isEmpty() && (m_collective.at(0)->isQmlProperty());
31 }
32 [[nodiscard]] qsizetype count() const { return m_collective.size(); }
33 void append(Node *node)
34 {
35 m_collective.append(node);
38 }
39 void sort() { std::sort(m_collective.begin(), m_collective.end(), Node::nodeNameLessThan); }
40 [[nodiscard]] const QList<Node *> &collective() const { return m_collective; }
41 void setOverloadFlags();
42 void setRelatedNonmember(bool value) override;
43 Node *clone(Aggregate *parent) override;
44
45private:
46 QList<Node *> m_collective {};
47};
48
49QT_END_NAMESPACE
50
51#endif // SHAREDCOMMENTNODE_H
#define ATOM_FORMATTING_TELETYPE
Definition atom.h:207
#define ATOM_FORMATTING_BOLD
Definition atom.h:199
#define ATOM_FORMATTING_TRADEMARK
Definition atom.h:208
#define ATOM_LIST_VALUE
Definition atom.h:214
#define ATOM_FORMATTING_ITALIC
Definition atom.h:201
#define ATOM_FORMATTING_LINK
Definition atom.h:202
const NodeList & childNodes() const
Returns a const reference to the child list.
Definition aggregate.h:41
The Atom class is the fundamental unit for representing documents internally.
Definition atom.h:18
AtomType type() const
Return the type of this atom.
Definition atom.h:149
AtomType
\value AnnotatedList \value AutoLink \value BaseName \value BriefLeft \value BriefRight \value C \val...
Definition atom.h:20
@ DivRight
Definition atom.h:39
@ FormatElse
Definition atom.h:44
@ Code
Definition atom.h:30
@ String
Definition atom.h:92
@ ListLeft
Definition atom.h:62
@ ExampleFileLink
Definition atom.h:40
@ ListRight
Definition atom.h:68
@ ParaRight
Definition atom.h:75
@ FormattingLeft
Definition atom.h:47
@ FormattingRight
Definition atom.h:48
@ Link
Definition atom.h:60
@ FormatEndif
Definition atom.h:45
@ ExampleImageLink
Definition atom.h:41
@ AutoLink
Definition atom.h:22
@ LinkNode
Definition atom.h:61
@ ParaLeft
Definition atom.h:74
@ FormatIf
Definition atom.h:46
const Atom * next() const
Return the next atom in the atom list.
Definition atom.h:146
The ClassNode represents a C++ class.
Definition classnode.h:21
PropertyNode * findPropertyNode(const QString &name)
Search the child list to find the property node with the specified name.
Definition classnode.cpp:57
QList< RelatedClass > & derivedClasses()
Definition classnode.h:39
void addResolvedBaseClass(Access access, ClassNode *node)
Adds the base class node to this class's list of base classes.
Definition classnode.cpp:27
QList< RelatedClass > & baseClasses()
Definition classnode.h:38
PropertyNode * findOverriddenProperty(const FunctionNode *fn)
fn is an overriding function in this class or in a class derived from this class.
FunctionNode * findOverriddenFunction(const FunctionNode *fn)
fn is an overriding function in this class or in a class derived from this class.
const QList< RelatedClass > & baseClasses() const
Definition classnode.h:42
bool isAbstract() const override
Returns true if the ClassNode or QmlTypeNode is marked abstract.
Definition classnode.h:44
QList< RelatedClass > & ignoredBaseClasses()
Definition classnode.h:40
bool isRelatableType() const override
Returns true if this node is something you can relate things to with the relates command.
Definition classnode.h:28
const QSet< QmlTypeNode * > & qmlNativeTypes()
Definition classnode.h:53
void setAbstract(bool b) override
If this node is a ClassNode or a QmlTypeNode, the node's abstract flag data member is set to b.
Definition classnode.h:45
bool docMustBeGenerated() const override
Returns true if the class or struct represented by this class node must be documented.
bool isFirstClassAggregate() const override
Returns true if this Node is an Aggregate but not a ProxyNode.
Definition classnode.h:26
void removePrivateAndInternalBases()
Remove private and internal bases classes from this class's list of base classes.
bool isQmlNativeType()
Definition classnode.h:52
bool isWrapper() const override
Returns true if the node is a class node or a QML type node that is marked as being a wrapper class o...
Definition classnode.h:29
void insertQmlNativeType(QmlTypeNode *qmlTypeNode)
Definition classnode.h:51
bool isClassNode() const override
Returns true if this is an instance of ClassNode.
Definition classnode.h:27
ClassNode(NodeType type, Aggregate *parent, const QString &name)
Definition classnode.h:23
void resolvePropertyOverriddenFromPtrs(PropertyNode *pn)
void addDerivedClass(Access access, ClassNode *node)
Adds the derived class node to this class's list of derived classes.
Definition classnode.cpp:37
void setWrapper() override
If this node is a ClassNode or a QmlTypeNode, the node's wrapper flag data member is set to true.
Definition classnode.h:30
void addUnresolvedBaseClass(Access access, const QStringList &path)
Add an unresolved base class to this class node's list of base classes.
Definition classnode.cpp:48
A class for holding the members of a collection of doc pages.
QString logicalModuleVersion() const override
Returns the logical module version.
void setQtVariable(const QString &v) override
If this node is a CollectionNode, its QT variable is set to v.
NodeMap getMembers(F &&predicate) const
bool hasClasses() const override
Returns true if this collection node contains at least one class node.
QString cmakeTargetItem() const override
const NodeList & members() const
NodeMap getMembers(Node::NodeType type) const
Returns a map containing this collection node's member nodes with a specified node type.
void setCMakeTargetItem(const QString &targetItem) override
bool hasNamespaces() const override
Returns true if this collection node contains at least one namespace node.
void setCMakePackage(const QString &package) override
bool wasSeen() const override
Returns the seen flag data member of this node if it is a NamespaceNode or a CollectionNode.
CollectionNode(NodeType type, Aggregate *parent, const QString &name)
QString qtVariable() const override
If this node is a CollectionNode, its QT variable is returned.
bool isCollectionNode() const override
Returns true if this is an instance of CollectionNode.
void setState(const QString &state)
QString logicalModuleName() const override
If this is a CollectionNode, this function returns the logical module name.
QString fullTitle() const override
Returns a string that can be used as the full title for the documentation of this node.
QString cmakeComponent() const override
void setLogicalModuleInfo(const QStringList &info) override
This function accepts the logical module info as a string list.
QString state() const
Sets or gets a description of this module's state.
QString logicalModuleIdentifier() const override
If this is a CollectionNode, this function returns the logical module identifier.
void addMember(Node *node) override
Appends node to the collection node's member list, if and only if it isn't already in the member list...
void setCMakeComponent(const QString &component) override
QString cmakePackage() const override
The Config class contains the configuration variables for controlling how qdoc produces documentation...
Definition config.h:84
bool preparing() const
Definition config.h:181
bool generating() const
Definition config.h:182
const Location & location() const
Returns the starting location of a qdoc comment.
Definition doc.cpp:90
const Text & body() const
Definition doc.cpp:115
QStringMultiMap * metaTagMap() const
Definition doc.cpp:292
EnumNode(Aggregate *parent, const QString &name, bool isScoped=false)
Definition enumnode.h:23
bool hasItem(const QString &name) const
Definition enumnode.h:30
Node * clone(Aggregate *parent) override
Clone this node on the heap and make the clone a child of parent.
Definition enumnode.cpp:67
void setFlagsType(TypedefNode *typedefNode)
Definition enumnode.cpp:76
void addItem(const EnumItem &item)
Add item to the enum type's item list.
Definition enumnode.cpp:18
const QList< EnumItem > & items() const
Definition enumnode.h:33
QString itemValue(const QString &name) const
Returns the enum value associated with the enum name.
Definition enumnode.cpp:39
void setSince(const QString &value, const QString &since)
Sets since information to a named enum value, if it exists in this enum.
Definition enumnode.cpp:52
const TypedefNode * flagsType() const
Definition enumnode.h:35
Access itemAccess(const QString &name) const
Returns the access level of the enumeration item named name.
Definition enumnode.cpp:29
bool isScoped() const
Definition enumnode.h:31
Encapsulate the logic that QDoc uses to find files whose path is provided by the user and that are re...
This node is used to represent any kind of function being documented.
signed short overloadNumber() const
Returns the overload number for this function.
bool isPrivateSignal() const
const Parameters & parameters() const
bool isMAssign() const
bool isVirtual() const
bool isCAssign() const
bool isInvokable() const
bool isDeprecated() const override
\reimp
bool hasOverloads() const
Returns true if this function has overloads.
bool returnsBool() const
bool isMarkedReimp() const override
Returns true if the FunctionNode is marked as a reimplemented function.
bool isDtor() const
bool isSignal() const
bool isQmlSignal() const
bool isOverload() const
bool isIgnored() const
In some cases, it is ok for a public function to be not documented.
bool isCCtor() const
bool isMCtor() const
bool isCtor() const
bool hasAssociatedProperties() const
Metaness metaness() const
bool m_quoting
Definition generator.h:203
void signatureList(const NodeList &nodes, const Node *relative, CodeMarker *marker)
Generate a bullet list of function signatures.
void appendSignature(Text &text, const Node *node)
Append the signature for the function named in node to text, so that is a link to the documentation f...
virtual void generateCollectionNode(CollectionNode *, CodeMarker *)
Definition generator.h:89
virtual void generateProxyPage(Aggregate *, CodeMarker *)
Definition generator.h:86
virtual void generateCppReferencePage(Aggregate *, CodeMarker *)
Definition generator.h:85
bool generateComparisonCategory(const Node *node, CodeMarker *marker=nullptr)
QMap< QString, QString > & formattingRightMap()
virtual void generateAddendum(const Node *node, Addendum type, CodeMarker *marker, bool generateNote)
Generates an addendum note of type type for node, using marker as the code marker.
virtual QString typeString(const Node *node)
static bool hasExceptions(const Node *node, NodeList &reentrant, NodeList &threadsafe, NodeList &nonreentrant)
void generateEnumValuesForQmlProperty(const Node *node, CodeMarker *marker)
FileResolver & file_resolver
Definition generator.h:194
virtual void initializeFormat()
Reads format-specific variables from config, sets output (sub)directories, creates them on the filesy...
virtual void generateDocumentation(Node *node)
Recursive writing of HTML files from the root node.
static void initialize()
const Atom * generateAtomList(const Atom *atom, const Node *relative, CodeMarker *marker, bool generate, int &numGeneratedAtoms)
void generateStatus(const Node *node, CodeMarker *marker)
virtual void generateAlsoList(const Node *node, CodeMarker *marker)
void appendFullName(Text &text, const Node *apparentNode, const Node *relative, const Node *actualNode=nullptr)
Definition generator.cpp:92
virtual void generateFileList(const ExampleNode *en, CodeMarker *marker, bool images)
This function is called when the documentation for an example is being formatted.
void generateThreadSafeness(const Node *node, CodeMarker *marker)
Generates text that explains how threadsafe and/or reentrant node is.
static void terminate()
Generator(FileResolver &file_resolver)
Constructs the generator base class.
Definition generator.cpp:76
QDocDatabase * m_qdb
Definition generator.h:196
bool m_inContents
Definition generator.h:198
bool generateComparisonList(const Node *node)
Generates a list of types that compare to node with the comparison category that applies for the rela...
static bool useOutputSubdirs()
Definition generator.h:68
void generateNoexceptNote(const Node *node, CodeMarker *marker)
void unknownAtom(const Atom *atom)
virtual bool generateText(const Text &text, const Node *relative, CodeMarker *marker)
Generate the documentation for relative.
virtual void terminateGenerator()
static bool matchAhead(const Atom *atom, Atom::AtomType expectedAtomType)
QString fullDocumentLocation(const Node *node)
Returns the full document location.
bool m_inLink
Definition generator.h:197
void addImageToCopy(const ExampleNode *en, const ResolvedFile &resolved_file)
virtual void generateDocs()
Traverses the database recursively to generate all the documentation.
int appendSortedQmlNames(Text &text, const Node *base, const NodeList &subs)
bool m_inTableHeader
Definition generator.h:200
void generateOverloadedSignal(const Node *node, CodeMarker *marker)
If the node is an overloaded signal, add a node with an example on how to connect to it.
static bool appendTrademark(const Atom *atom)
Returns true if a trademark symbol should be appended to the output as determined by atom.
bool m_inSectionHeading
Definition generator.h:199
virtual int skipAtoms(const Atom *atom, Atom::AtomType type) const
int m_numTableRows
Definition generator.h:204
bool m_threeColumnEnumValueTable
Definition generator.h:201
virtual void generateQmlTypePage(QmlTypeNode *, CodeMarker *)
Definition generator.h:87
QTextStream & out()
virtual void generateBody(const Node *node, CodeMarker *marker)
Generate the body of the documentation from the qdoc comment found with the entity represented by the...
QString outFileName()
virtual void generatePageNode(PageNode *, CodeMarker *)
Definition generator.h:88
virtual ~Generator()
Destroys the generator after removing it from the list of output generators.
Definition generator.cpp:87
void generateSince(const Node *node, CodeMarker *marker)
QMap< QString, QString > & formattingLeftMap()
int appendSortedNames(Text &text, const ClassNode *classe, const QList< RelatedClass > &classes)
void endSubPage()
Flush the text stream associated with the subpage, and then pop it off the text stream stack and dele...
virtual void generateAddendum(const Node *node, Addendum type, CodeMarker *marker)
Definition generator.h:122
static void resetUseOutputSubdirs()
Definition generator.h:67
@ AssociatedProperties
Definition generator.h:39
@ PrivateSignal
Definition generator.h:37
@ QmlSignalHandler
Definition generator.h:38
@ BindableProperty
Definition generator.h:40
bool m_showInternal
Definition generator.h:202
virtual void generateGenericCollectionPage(CollectionNode *, CodeMarker *)
Definition generator.h:90
virtual QString fileBase(const Node *node) const
virtual void initializeGenerator()
Updates the generator's m_showInternal from the Config.
void initializeTextOutput()
Resets the variables used during text output.
void generateRequiredLinks(const Node *node, CodeMarker *marker)
Generates either a link to the project folder for example node, or a list of links files/images if 'u...
static Generator * currentGenerator()
Definition generator.h:57
The Location class provides a way to mark a location in a file.
Definition location.h:15
Location()
Constructs an empty location.
Definition location.cpp:40
bool isGenericCollection() const
Returns true if the node type is Collection.
Definition node.h:166
bool isExternalPage() const
Returns true if the node type is ExternalPage.
Definition node.h:134
const Doc & doc() const
Returns a reference to the node's Doc data member.
Definition node.h:271
bool isQmlNode() const
Returns true if this node's Genus value is QML.
Definition node.h:153
void setGenus(Genus t)
Definition node.h:125
virtual bool docMustBeGenerated() const
This function is called to perform a test to decide if the node must have documentation generated.
Definition node.h:228
virtual bool isWrapper() const
Returns true if the node is a class node or a QML type node that is marked as being a wrapper class o...
Definition node.cpp:953
bool isPrivate() const
Returns true if this node's access is Private.
Definition node.h:146
NodeType
An unsigned char value that identifies an object as a particular subclass of Node.
Definition node.h:54
@ Variable
Definition node.h:69
@ Module
Definition node.h:71
@ Struct
Definition node.h:58
@ QmlModule
Definition node.h:73
@ Typedef
Definition node.h:66
@ QmlValueType
Definition node.h:75
@ Function
Definition node.h:65
@ TypeAlias
Definition node.h:67
@ Union
Definition node.h:59
@ Page
Definition node.h:61
@ Group
Definition node.h:70
@ Enum
Definition node.h:62
@ HeaderFile
Definition node.h:60
@ QmlProperty
Definition node.h:74
@ QmlType
Definition node.h:72
@ SharedComment
Definition node.h:76
@ Namespace
Definition node.h:56
@ Property
Definition node.h:68
@ Class
Definition node.h:57
bool isNamespace() const
Returns true if the node type is Namespace.
Definition node.h:143
ComparisonCategory comparisonCategory() const
Definition node.h:217
bool hasFileNameBase() const
Returns true if the node's file name base has been set.
Definition node.h:200
bool isFunction(Genus g=DontCare) const
Returns true if this is a FunctionNode and its Genus is set to g.
Definition node.h:135
bool isQmlType() const
Returns true if the node type is QmlType or QmlValueType.
Definition node.h:155
bool isSharedCommentNode() const
Returns true if the node type is SharedComment.
Definition node.h:158
virtual bool isInternal() const
Returns true if the node's status is Internal, or if its parent is a class with Internal status.
Definition node.cpp:849
bool isHeader() const
Returns true if the node type is HeaderFile.
Definition node.h:140
virtual bool isPageNode() const
Returns true if this node represents something that generates a documentation page.
Definition node.h:182
virtual bool isMacro() const
returns true if either FunctionNode::isMacroWithParams() or FunctionNode::isMacroWithoutParams() retu...
Definition node.h:181
bool isEnumType() const
Returns true if the node type is Enum.
Definition node.h:132
virtual bool isTextPageNode() const
Returns true if the node is a PageNode but not an Aggregate.
Definition node.h:187
virtual bool isAttached() const
Returns true if the QML property or QML method node is marked as attached.
Definition node.h:176
Aggregate * parent() const
Returns the node's parent pointer.
Definition node.h:244
static bool fromFlagValue(FlagValue fv, bool defaultValue)
Converts the enum fv back to a boolean value.
Definition node.cpp:748
virtual bool isDeprecated() const
Returns true if this node's status is Deprecated.
Definition node.h:168
virtual bool isAggregate() const
Returns true if this node is an aggregate, which means it inherits Aggregate and can therefore have c...
Definition node.h:170
NodeType nodeType() const
Returns this node's type.
Definition node.h:121
FlagValue
A value used in PropertyNode and QmlPropertyNode that can be -1, 0, or +1.
Definition node.h:114
@ FlagValueDefault
Definition node.h:114
void setSharedCommentNode(SharedCommentNode *t)
Definition node.h:286
static bool nodeNameLessThan(const Node *first, const Node *second)
Returns true if the node n1 is less than node n2.
Definition node.cpp:57
const Location & location() const
If this node's definition location is empty, this function returns this node's declaration location.
Definition node.h:267
bool isProxyNode() const
Returns true if the node type is Proxy.
Definition node.h:148
Access access() const
Returns the node's Access setting, which can be Public, Protected, or Private.
Definition node.h:264
ThreadSafeness threadSafeness() const
Returns the thread safeness value for whatever this node represents.
Definition node.cpp:826
virtual bool isMarkedReimp() const
Returns true if the FunctionNode is marked as a reimplemented function.
Definition node.h:184
bool isProperty() const
Returns true if the node type is Property.
Definition node.h:147
bool isModule() const
Returns true if the node type is Module.
Definition node.h:142
virtual bool isPropertyGroup() const
Returns true if the node is a SharedCommentNode for documenting multiple C++ properties or multiple Q...
Definition node.h:185
Genus genus() const
Returns this node's Genus.
Definition node.h:124
ThreadSafeness
An unsigned char that specifies the degree of thread-safeness of the element.
Definition node.h:97
@ ThreadSafe
Definition node.h:101
@ UnspecifiedSafeness
Definition node.h:98
@ Reentrant
Definition node.h:100
bool isSharingComment() const
This function returns true if the node is sharing a comment with other nodes.
Definition node.h:285
bool hasDoc() const
Returns true if this node is documented, or it represents a documented node read from the index ('had...
Definition node.cpp:906
static FlagValue toFlagValue(bool b)
Converts the boolean value b to an enum representation of the boolean type, which includes an enum va...
Definition node.cpp:737
LinkType
An unsigned char value that probably should be moved out of the Node base class.
Definition node.h:112
virtual bool isClassNode() const
Returns true if this is an instance of ClassNode.
Definition node.h:177
virtual bool isCollectionNode() const
Returns true if this is an instance of CollectionNode.
Definition node.h:178
@ Internal
Definition node.h:93
@ Active
Definition node.h:92
@ Deprecated
Definition node.h:90
@ Preliminary
Definition node.h:91
bool isQmlModule() const
Returns true if the node type is QmlModule.
Definition node.h:152
@ SignaturePlain
Definition node.h:105
bool isExample() const
Returns true if the node type is Example.
Definition node.h:133
bool isIndexNode() const
Returns true if this node was created from something in an index file.
Definition node.h:141
Status status() const
Returns the node's status value.
Definition node.h:278
bool isQmlProperty() const
Returns true if the node type is QmlProperty.
Definition node.h:154
QString numberString() const
ListStyle style() const
Definition openedlist.h:25
OpenedList(const Location &location, const QString &hint)
QString prefix() const
Definition openedlist.h:29
QString styleString() const
bool isStarted() const
Definition openedlist.h:24
void next()
Definition openedlist.h:22
QString suffix() const
Definition openedlist.h:30
int number() const
Definition openedlist.h:27
OpenedList(ListStyle style)
A PageNode is a Node that generates a documentation page.
Definition pagenode.h:18
bool noAutoList() const
Returns the value of the no auto-list flag.
Definition pagenode.h:41
This class describes one instance of using the Q_PROPERTY macro.
PropertyType propertyType() const
This class provides exclusive access to the qdoc database, which consists of a forrest of trees and a...
static QDocDatabase * qdocDB()
Creates the singleton.
NamespaceNode * primaryTreeRoot()
Returns a pointer to the root node of the primary tree.
const CollectionNode * getModuleNode(const Node *relative)
Returns the collection node representing the module that relative node belongs to,...
void mergeCollections(CollectionNode *c)
Finds all the collection nodes with the same name and type as c and merges their members into the mem...
bool isStored() const
const QString & dataType() const
const EnumNode * enumNode() const
Returns the node representing the C++ enumeration associated with this property, or \nullptr.
const QString & enumPrefix() const
Returns the prefix to use for documentated enumerators from the associated C++ enum for this property...
bool isDefault() const override
Returns true if the QML property node is marked as default.
QString qmlTypeName() const override
If this is a QmlPropertyNode or a FunctionNode representing a QML method, this function returns the q...
QString element() const override
If this node is a QmlPropertyNode or a FunctionNode, this function returns the name of the parent nod...
const QString & defaultValue() const
void markReadOnly(bool flag) override
If this node is a QmlPropertyNode, then the property's read-only flag is set to flag.
QString logicalModuleIdentifier() const override
If this is a CollectionNode, this function returns the logical module identifier.
void markDefault() override
If this node is a QmlPropertyNode, it is marked as the default property.
QmlPropertyNode(Aggregate *parent, const QString &name, QString type, bool attached)
Constructor for the QML property node.
void setDefaultValue(const QString &value)
bool isReadOnly() const
Returns true if this QML property node is marked as a read-only property.
bool isRequired()
Returns true if this QML property is marked with \required or the corresponding C++ property uses the...
QString logicalModuleName() const override
If this is a CollectionNode, this function returns the logical module name.
void setStored(bool stored)
bool setEnumNode(const QString &path, const QString &registeredQmlName)
Locates the node specified by path and sets it as the C++ enumeration associated with this property.
void setDataType(const QString &dataType) override
If this node is a PropertyNode or a QmlPropertyNode, its data type data member is set to dataType.
bool isReadOnly()
Returns true if this QML property or attached property is read-only.
bool isAlias() const override
Returns true if this QML property is marked as an alias.
QString logicalModuleVersion() const override
If this is a CollectionNode, this function returns the logical module version number.
bool isAttached() const override
Returns true if the QML property or QML method node is marked as attached.
void reset()
Definition quoter.cpp:106
QString quoteTo(const Location &docLocation, const QString &command, const QString &pattern)
Definition quoter.cpp:224
QString quoteSnippet(const Location &docLocation, const QString &identifier)
Definition quoter.cpp:182
Quoter()
Definition quoter.cpp:84
QString quoteUntil(const Location &docLocation, const QString &command, const QString &pattern)
Definition quoter.cpp:246
void quoteFromFile(const QString &userFriendlyFileName, const QString &plainCode, const QString &markedCode)
Definition quoter.cpp:114
static QStringList splitLines(const QString &line)
Definition quoter.cpp:33
QString quoteLine(const Location &docLocation, const QString &command, const QString &pattern)
Definition quoter.cpp:158
const QList< Node * > & collective() const
void setOverloadFlags()
Searches the shared comment node's member nodes for function nodes.
Node * clone(Aggregate *parent) override
Clone this node on the heap and make the clone a child of parent.
SharedCommentNode(Node *node)
qsizetype count() const
bool isPropertyGroup() const override
Returns true if the node is a SharedCommentNode for documenting multiple C++ properties or multiple Q...
void append(Node *node)
void setRelatedNonmember(bool value) override
Sets the related nonmember flag in this node and in each node in the shared comment's collective to v...
~SharedCommentNode() override
SharedCommentNode(QmlTypeNode *parent, int count, QString &group)
Definition text.h:12
const Atom * firstAtom() const
Definition text.h:34
bool isEmpty() const
Definition text.h:31
void clear()
Definition text.cpp:269
const QString & aliasedType() const
Definition typedefnode.h:45
Node * clone(Aggregate *parent) override
Clone this node on the heap and make the clone a child of parent.
TypeAliasNode(Aggregate *parent, const QString &name, const QString &aliasedType)
Definition typedefnode.h:40
const EnumNode * associatedEnum() const
Definition typedefnode.h:26
TypedefNode(Aggregate *parent, const QString &name, NodeType type=Typedef)
Definition typedefnode.h:20
bool hasAssociatedEnum() const
Definition typedefnode.h:25
Node * clone(Aggregate *parent) override
Clone this node on the heap and make the clone a child of parent.
#define SKIP_CHAR()
#define CONFIG_REDIRECTDOCUMENTATIONTODEVNULL
Definition config.h:374
#define CONFIG_AUTOLINKERRORS
Definition config.h:323
#define CONFIG_EXTRAIMAGES
Definition config.h:340
#define CONFIG_EXAMPLES
Definition config.h:336
#define CONFIG_URL
Definition config.h:391
#define CONFIG_OUTPUTSUFFIXES
Definition config.h:371
#define CONFIG_OUTPUTPREFIXES
Definition config.h:370
#define CONFIG_NOLINKERRORS
Definition config.h:367
#define CONFIG_PROJECT
Definition config.h:373
#define CONFIG_EXAMPLESINSTALLPATH
Definition config.h:337
#define CONFIG_PRODUCTNAME
Definition config.h:372
#define CONFIG_QUOTINGINFORMATION
Definition config.h:376
#define CONFIG_STYLESHEETS
Definition config.h:384
#define CONFIG_FORMATTING
Definition config.h:342
#define CONFIG_SCRIPTS
Definition config.h:377
QMultiMap< QString, QString > QStringMultiMap
Definition doc.h:28
QT_BEGIN_NAMESPACE int editDistance(const QString &s, const QString &t)
QString nearestName(const QString &actual, const QSet< QString > &candidates)
Combined button and popup list for selecting options.
QList< Node * > NodeList
Definition node.h:41
QMap< QString, Node * > NodeMap
Definition node.h:44
Q_DECLARE_TYPEINFO(OpenedList, Q_RELOCATABLE_TYPE)
static QLatin1String gt("&gt;")
#define SKIP_SPACE
static void startNote(Text &text)
static QLatin1String amp("&amp;")
static QLatin1String quot("&quot;")
static QLatin1String lt("&lt;")
static QRegularExpression tag("</?@[^>]*>")
std::optional< QString > formatStatus(const Node *node, QDocDatabase *qdb)
Represents a file that is reachable by QDoc based on its current configuration.