| 1 | // Copyright (C) 2020 The Qt Company Ltd. |
|---|
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 |
|---|
| 3 | |
|---|
| 4 | #include "externalpagenode.h" |
|---|
| 5 | |
|---|
| 6 | QT_BEGIN_NAMESPACE |
|---|
| 7 | |
|---|
| 8 | /*! |
|---|
| 9 | \class ExternalPageNode |
|---|
| 10 | |
|---|
| 11 | \brief The ExternalPageNode represents an external documentation page. |
|---|
| 12 | |
|---|
| 13 | Qdoc can generate links to pages that are not part of the documentation |
|---|
| 14 | being generated. 3rd party software pages are often referenced by links |
|---|
| 15 | from the QT documentation. Qdoc creates an ExternalPageNode when it sees |
|---|
| 16 | an \c {\\externalpage} command. The HTML generator can then use the node |
|---|
| 17 | when it needs to create links to the external page. |
|---|
| 18 | |
|---|
| 19 | ExternalPageNode inherits PageNode. |
|---|
| 20 | */ |
|---|
| 21 | |
|---|
| 22 | /*! \fn ExternalPageNode::ExternalPageNode(Aggregate *parent, const QString &name) |
|---|
| 23 | The constructor creates an ExternalPageNode as a child node of \a parent. |
|---|
| 24 | It's \a name is the argument from the \c {\\externalpage} command. The node |
|---|
| 25 | type is Node::ExternalPage, and the page type is Node::ArticlePage. |
|---|
| 26 | */ |
|---|
| 27 | |
|---|
| 28 | QT_END_NAMESPACE |
|---|
| 29 | |
|---|
