Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Friends | List of all members
QQmlJS::Dom::RegionComments Class Reference

Keeps the comments associated with a DomItem. More...

#include <qqmldomcomments_p.h>

+ Collaboration diagram for QQmlJS::Dom::RegionComments:

Public Member Functions

DomType kind () const
 
bool iterateDirectSubpaths (const DomItem &self, DirectVisitor visitor) const
 
const QMap< FileLocationRegion, CommentedElement > & regionComments () const
 
Path addComment (const Comment &comment, FileLocationRegion region)
 

Static Public Attributes

static constexpr DomType kindValue = DomType::RegionComments
 

Friends

bool operator== (const RegionComments &c1, const RegionComments &c2)
 
bool operator!= (const RegionComments &c1, const RegionComments &c2)
 

Detailed Description

Keeps the comments associated with a DomItem.

A DomItem can be more complex that just a start/end, it can have multiple regions, for example a return or a function token might define a region. The empty string is the region that represents the whole element.

Every region has a name, and should be written out using the OutWriter.writeRegion (or startRegion/ EndRegion). Region comments keeps a mapping containing them.

Definition at line 148 of file qqmldomcomments_p.h.

Member Function Documentation

◆ addComment()

Path QQmlJS::Dom::RegionComments::addComment ( const Comment & comment,
FileLocationRegion region )
inline

Definition at line 166 of file qqmldomcomments_p.h.

References QQmlJS::Dom::Comment::type().

+ Here is the call graph for this function:

◆ iterateDirectSubpaths()

bool QQmlJS::Dom::RegionComments::iterateDirectSubpaths ( const DomItem & self,
DirectVisitor visitor ) const

Definition at line 749 of file qqmldomcomments.cpp.

References map.

◆ kind()

DomType QQmlJS::Dom::RegionComments::kind ( ) const
inline

Definition at line 152 of file qqmldomcomments_p.h.

◆ regionComments()

const QMap< FileLocationRegion, CommentedElement > & QQmlJS::Dom::RegionComments::regionComments ( ) const
inline

Definition at line 165 of file qqmldomcomments_p.h.

Friends And Related Symbol Documentation

◆ operator!=

bool operator!= ( const RegionComments & c1,
const RegionComments & c2 )
friend

Definition at line 160 of file qqmldomcomments_p.h.

◆ operator==

bool operator== ( const RegionComments & c1,
const RegionComments & c2 )
friend

Definition at line 156 of file qqmldomcomments_p.h.

Member Data Documentation

◆ kindValue

constexpr DomType QQmlJS::Dom::RegionComments::kindValue = DomType::RegionComments
staticconstexpr

Definition at line 151 of file qqmldomcomments_p.h.

The documentation for this class was generated from the following files: