| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
\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>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
When using an \fn command to document a function that has default
values for parameter(s), The Clang parser retrieves a relevant
section of the source file that contains the expression for the
default value. In case of \fn, the source is a temporary translation
unit that was constructed on the fly - but it may not exist anymore,
and the default value is lost.
Fix this by storing the contents of the temporary TU for later access.
Fixes: QTBUG-83472
Change-Id: I20ad9e3322636450db1def65933837c1c767f2c4
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
|
| |
|
|
|
|
|
|
|
|
| |
QDoc allows macros to be nested, and macro parameters can also be
other macros, but in one code path the parameter was read verbatim,
i.e. not expanded. This is an unnecessary restriction so remove it.
Fixes: QTBUG-83085
Change-Id: I6dc7c2f7586a65bee78096fb50685262dad2ffe3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
Even though the \noautolist has been documented to work for C++ module
pages, using it within \module documentation had no effect. Generate
the list of namespaces and classes only if \noautolist does not appear
on the module page.
Add a test for \noautolist, for both HTML and DocBook generators.
Fixes: QTBUG-82822
Change-Id: I27dcdafaa44981f18d08f2f27a148a1febba2d8a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fix all QDoc warnings for the tests and set the warning limit to zero.
If any warnings are introduced, QDoc will exit with non-zero value and
the test will fail.
The exceptions are the tests specific to the DocBook generator, where
we expect to see two warnings related to shared comment nodes. The
generator currently has trouble handling these.
Fixes: QTBUG-82808
Change-Id: I0482516e1e34b92592d921a4a0ffb41e4b2b4770
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Shared comment nodes were not handled as a special case when generating
"This [class/function/method/type/etc] was introduced in" strings when
QDoc encountered a \since command. These ended up with the default
value, "documentation", which led to unexpected text in the
documentation.
* Add handling of shared comment nodes and get the node type from the
first node in the collective.
* Amend generated output test to cover this scenario.
Fixes: QTBUG-82534
Change-Id: I444e95e0214f312649ec2720c23c98e698402abf
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The command was documented as taking no arguments, and any arguments
were ignored. The documentation still has many instances of
\obsolete Use somethingElse() instead.
Where the description was lost. Force a linebreak after the command,
allowing any arguments to be processed as a normal text paragraph.
[ChangeLog][qdoc] Generate output for arguments passed to the \obsolete
command.
Fixes: QTBUG-82558
Change-Id: If3e39382367a0c1f4cc63a2c322e986e053ecd6b
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
|
|
|
As the test has grown in size and scope, the lack of structure adds an
unnecessary mental overhead when adding new tests, or when attempting to
refactor the tests themselves.
- Place all testdata in a directory aptly named testdata, following Qt
convention.
- Create sub-directories for all tests, so that their data is separated
from each other.
- Update qdocconf-files to match the new structure.
- Update expected output data to match changes in qdocconf-files.
- Ensure all tests still run; this requires modifications to paths in
.qdocconf files mostly, but also in #include directives.
Fixes: QTBUG-82159
Change-Id: I43b2333cacc75d1076a8aca86e89ccc52e4ec8a3
Reviewed-by: Levon Sargsyan <levon.sargsyan@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
|
