diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-04-21 23:57:46 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-04-23 10:19:54 +0200 |
| commit | e967772fe884dd8a488a359c122c9cbae9d94c55 (patch) | |
| tree | 570c6bb5f46ef5409f4508a746dbde4542f7d7a9 /src/qdoc/cppcodemarker.cpp | |
| parent | 95cd9078938bcd88fdfbba707911e8111f59f195 (diff) | |
qdoc: properly implement \typealias command
\typealias was already a command recognized by QDoc, but it was simply
treated as a synonym for \typedef and was not documented. Implement
proper support for the command:
- Add [alias] designation both in type summary and details.
- Auto-generate information about the aliased type, including a link
if aliasing a public, documented type.
- Auto-convert aliases documented with \typedef to type aliases.
- Add basic support for aliases also to DocBook and WebXML generators.
- Document \typealias.
Fixes: QTBUG-82712
Change-Id: Iafa8c7def0a7488d7521fbc2862290a9bb3167ff
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/qdoc/cppcodemarker.cpp')
| -rw-r--r-- | src/qdoc/cppcodemarker.cpp | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/qdoc/cppcodemarker.cpp b/src/qdoc/cppcodemarker.cpp index 38dd8e79f..79313e2dd 100644 --- a/src/qdoc/cppcodemarker.cpp +++ b/src/qdoc/cppcodemarker.cpp @@ -252,6 +252,13 @@ QString CppCodeMarker::markedUpSynopsis(const Node *node, const Node * /* relati synopsis += QLatin1Char('}'); } break; + case Node::TypeAlias: + if (style == Section::Summary) + synopsis = "(alias) "; + else if (style == Section::Details) + extra = QStringLiteral("[alias] "); + synopsis += name; + break; case Node::Typedef: typedeff = static_cast<const TypedefNode *>(node); if (typedeff->associatedEnum()) { |