sharedcommentnode.cpp

Go to the documentation of this file.

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
 
#include "sharedcommentnode.h"
 
#include "aggregate.h"
#include "functionnode.h"
#include "qmltypenode.h"
 
QT_BEGIN_NAMESPACE
 
using namespace Qt::StringLiterals;
 
SharedCommentNode::SharedCommentNode(QmlTypeNode *parent, int count, QString &group)
    : Node(NodeType::SharedComment, parent, group)
{
    m_collective.reserve(count);
}
 
/*!
  Returns the logical module name of the parent, as for the
  QML methods and properties that the shared comment documents.
 */
QString SharedCommentNode::logicalModuleName() const
{
    return parent()->logicalModuleName();
}
 
/*!
  Searches the shared comment node's member nodes for function
  nodes. Each function node's overload flag is set.
 
  If the shared comment is marked with \\overload primary, only the
  first function in the collective is marked as the primary overload.
 */
void SharedCommentNode::setOverloadFlags()
{
    // Check if this is \overload primary
    const auto &overloadArgs = doc().overloadList();
    bool isPrimaryOverload = !overloadArgs.isEmpty()
        && overloadArgs.first().first == "__qdoc_primary_overload__"_L1;
 
    size_t functionIndex = 0;
    for (auto *node : m_collective) {
        if (node->isFunction()) {
            auto *fn = static_cast<FunctionNode *>(node);
 
            // Only the FIRST function in a shared comment gets the primary flag
            if (isPrimaryOverload && functionIndex == 0)
                fn->setPrimaryOverloadFlag();
 
            fn->setOverloadFlag();
            ++functionIndex;
        }
    }
}
 
/*!
  Clone this node on the heap and make the clone a child of
  \a parent.
 
  Returns the pointer to the clone.
 */
Node *SharedCommentNode::clone(Aggregate *parent)
{
    auto *scn = new SharedCommentNode(*this); // shallow copy
    scn->setParent(nullptr);
    parent->addChild(scn);
 
    return scn;
}
 
/*!
  Sets the related nonmember flag in this node and in each
  node in the shared comment's collective to \a value.
 */
void SharedCommentNode::setRelatedNonmember(bool value)
{
    Node::setRelatedNonmember(value);
    for (auto *node : m_collective)
        node->setRelatedNonmember(value);
}
 
QT_END_NAMESPACE