summaryrefslogtreecommitdiffstats
path: root/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html
Commit message (Collapse)AuthorAgeFilesLines
* QDoc: Move tst_generatedoutput under srcLuca Di Sera2023-08-091-196/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | QDoc is currently restructuring its source code to simplify certain expected future developments. As part of this restructuring, all tests have been moving from the "tests" directory to an appropriate place under the "src" directory. `tst_generatedoutput` performs end-to-end regression testing for the "qdoc" binary. It was previously positioned under the "test" directory and is now moved under the "src/qdoc/test" directory, as part of the restructuring. The "CMakeLists.txt" file under "src/qdoc/qdoc/test" was modified to dispatch to the moved "generatedoutput" test directory. The "CMakeLists.txt" file in "tests/auto/qdoc" was modified to include "src/qdoc/qdoc/tests/generatedoutput/CMakeLists.txt", to ensure that `tst_generatedoutput` is able to run in CI. Adds SPDX license headers to files that were missing it in "generatedoutput/testdata" Change-Id: I412496ef0bf8ea9c07deda63960c11f0a5a06cc4 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Wrap a <div> around the addendum noteVenugopal Shivashankar2023-05-121-6/+6
| | | | | | | | | | | The addendum added to the C++ and QML methods, properties, and signals, lack the necessary styling. They are added as a simple HTML para, without the appropriate admonition CSS class, which is normally used for a \note. Pick-to: 6.5 Change-Id: I10cb9d51c587fb21024168a57e8661f7da0ad323 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Allow custom status descriptions for C++, QML typesTopi Reinio2023-04-241-1/+1
| | | | | | | | | | | | | | | | | | QDoc already allows defining a custom status for C++ and QML modules via the \modulestate command. In Qt, this is typically used for marking a module and its types with 'Technology preview' status. Allow a custom status for individual types as well, with \meta {status} {<description>} command. This information is added to the 'Requisites' table on top of the type reference page. Document the new status argument for \meta, and update its documentation as it contained obsolete information. Pick-to: 6.5 Task-number: QTBUG-113026 Change-Id: I5a13aa8650b6e188ffe50a1e948da90474bfb7a0 Reviewed-by: Luca Di Sera <luca.disera@qt.io>
* qdoc: Add meta description header to HTML outputTopi Reinio2023-03-061-0/+1
| | | | | | | | | | | | | | | | A meta description is an HTML element that provides a brief summary of a web page, typically displayed as part of a search engine results page. Use the \brief description for pages that have it. This should cover virtually all of the API reference as type \brief appears on module pages and therefore is rarely missing. Many overview \page's have it as well. Pick-to: 5.15 6.2 6.4 6.5 Fixes: QTBUG-111360 Change-Id: Ie403777fd895a995bbd7d717333e95c1b6b77d89 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* qdoc: Append translate attribute to few more blocksVenugopal Shivashankar2022-11-291-35/+35
| | | | | | | | | | | | - Auto links - Qml property summary and method signature - Anchors - See also entries - All C++ classes and QML types list Task-number: QTBUG-106679 Change-Id: Ib7046321ccac16bf1141885a5cf2d411084f57ab Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Add translate attribute to HTML blocksVenugopal Shivashankar2022-11-181-24/+24
| | | | | | | | | | | | | | A browser translates everything by default, which means even the <code>, <pre>, <table>s listing the class members, and so on, are also translated. With this change, such HTML blocks will include the "translate=no" attribute, indicating that they should not be translated. Pick-to: 6.4 6.2 5.15 Fixes: QTBUG-106679 Done-with: Topi Reinio <topi.reinio@qt.io> Change-Id: I446fe26c73b9e3fee2984297bd504ae72c555e73 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Make types inherit \since statement from their module docsTopi Reinio2022-07-131-1/+1
| | | | | | | | | | | | | | | When introducing a new module (C++ or QML) documentation, the \module or \qmlmodule topic should be marked with a \since command. Types belonging to the module will then inherit the \since by default, unless explicitly specified in the type documentation. Unify the interface of a similar Tree::resolveUsingClauses() method to explicitly require a reference to an Aggregate for the recursive operation. Fixes: QTBUG-104613 Change-Id: I48afe82e55a889dab43d8c59882c52d44b8bb69a Reviewed-by: Luca Di Sera <luca.disera@qt.io>
* qdoc: Improve generated navigation bar for C++ and QML typesTopi Reinio2022-04-281-0/+2
| | | | | | | | | | | | | | | | | | | QDoc included only the page(s) provided in navigation.cppclassespage and navigation.qmltypespage in the navigation bar (breadcrumbs) generated for type reference pages. If a type is part of some other (sub-)module, include a link to that module specifically after the generic 'C++ Classes' or 'QML Types' link. In passing, fix an issue where QML type pages lost an entry for *this* page on the navigation bar if the navigation config variable was not set. Pick-to: 6.2 6.3 Fixes: QTBUG-102387 Change-Id: I1316082858455938e4f4e2173f527b87c9a78f08 Reviewed-by: Luca Di Sera <luca.disera@qt.io>
* QDoc: clean up html outputPaul Wicking2021-05-251-30/+30
| | | | | | | | | | | | | | | | | | Clean up some of QDoc's html output: * Remove erroneous <p/>. * Do not write empty <ul></ul> for lists that don't exist. * Do not generate links with missing href. * Drop duplicated anchors in tables. * Stop writing unnecessary and broken links to qml modules. * Don't duplicate <b>'s. * Change Atom type to Autolink for Q_INVOKABLE to not generate broken <a> tag if link target cannot be resolved. Task-number: QTBUG-81209 Task-number: QTBUG-73026 Fixes: QTBUG-93876 Change-Id: I4e9f01571263a21e0c25e5d8b3b7ff10fc18bea7 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* QDoc: Improve Text::operator<<()Paul Wicking2021-05-201-1/+0
| | | | | | | | | | | | | | Add a check to Text::operator<<() to stops QDoc from outputting unnecessary "empty" spans, i.e. <span class="subtitle"></span> when generating html. Task-number: QTBUG-81209 Task-number: QTBUG-73026 Change-Id: I4df7875ee1c29bc1d48e9c3e53e8ce0518f3be3e Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Improve \deprecated commandPaul Wicking2021-05-101-0/+1
| | | | | | | | | | | | | | | | | | | | | | This change allows users to specify an optional parameter to the \deprecated command to record which version something was deprecated. It also allows for free text descriptions. These descriptions become the first paragraph of the resulting documentation. Usage: \deprecated \deprecated [6.2] \deprecated [6.2] Use QFoo() instead. \deprecated Use QFoo() instead. [ChangeLog][qdoc] QDoc now lets you record the version something is deprecated and suggest replacements with the \deprecated command. Task-number: QTBUG-58249 Change-Id: I27081627132b2f8ea3dd7d48ded8e37213366074 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Revert "QDoc: Add \deprecatedsince command"Paul Wicking2021-04-301-12/+0
| | | | | | | | | | | | This reverts commit 1637d91efd8fb389bc09bdaa960f5d9d4f9e0164. Reason for revert: User feedback shows this implementation isn't good enough. Further discussion led to the discovery of a better approach. Task-number: QTBUG-58249 Change-Id: I48e0500ac95745b1ce10a29e77c6fa515b9e048f Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* QDoc: Add \deprecatedsince commandPaul Wicking2021-04-281-0/+12
| | | | | | | | | | | | | As deprecated methods may stick around over a couple of versions, add a command that lets us record which version something was deprecated in. [ChangeLog][qdoc] QDoc now lets you record the version something is deprecated in with the new \deprecatedsince command. Fixes: QTBUG-58249 Change-Id: I69de350502580f446008f717462bbc1c4c251564 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* QDoc: Stop writing <a name=> html tagsPaul Wicking2021-04-261-36/+30
| | | | | | | Task-number: QTBUG-73026 Task-number: QTBUG-81209 Change-Id: I47d0fd94141d631abd8ea709c7ef0dc311312375 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Re-implement \default commandTopi Reinio2021-03-171-1/+1
| | | | | | | | | | | | | | Marking a QML property as a default property is now done with \qmldefault command; repurpose the \default command to set a default value for a property. The default value is visible in the detailed property documentation as an extra 'default: <value>' attribute. The value is taken as-is from the argument passed to the command. Fixes: QTBUG-81525 Change-Id: I7a4395e6e96046facfc3d75cc62a3bd01d04935b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* qdoc: Fix addendums for QML signals that contain '.' in the nameTopi Reinio2021-01-111-0/+12
| | | | | | | | | | QML signals may belong to a group, and the automatic note generation for corresponding signal handler must take this into account. Pick-to: 6.0 5.15 Fixes: QTBUG-85572 Change-Id: Ibfc793475618fb78a8ba0a0344537917ad6fb0bf Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* qdoc: Introduce \required command and handle REQUIRED for QML propertiesTopi Reinio2020-07-151-1/+1
| | | | | | | | | | | | | | | | | | | Q_PROPERTY macro now supports the REQUIRED keyword. This is relevant for QML types, where the type cannot be instatiated without declaring all required properties. Make QDoc parse the REQUIRED keyword, set associated QML property as required, and introduce a new command, \required, to do this explicitly in the docs. Likewise in QML visitor, check for the 'required' keyword for properties. [ChangeLog][qdoc] Support marking QML properties as required in the generated documentation. Fixes: QTBUG-85597 Change-Id: Ib8a25c5ebc1183812aec6e672b557c8fb1196741 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* qdoc: Extend synopsis for detailed reference sectionsTopi Reinio2020-06-081-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Include \since information for detailed synopsis generation, and allow duplication of qdoc comments for C++/QML nodes on the condition that the extra comments contain no body text, only meta-commands. The use case is to have full status information in the signature/section title, and allow additional meta-commands for items that share a documentation comment. /*! \fn void A:foo() \fn void A:foo(int i) Shared documentation for overloads. */ /*! \fn void A:foo(int i) \since 2.0 */ Extract the code for 'extra' synopsis into a new helper function and use for both HTML and DocBook generators. Fixes: QTBUG-55739 Fixes: QTBUG-82902 Change-Id: I6e797d3ce7bc7b02102bb949515f88e7a0fbe929 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Ensure QML method parameter types are generated correctlyTopi Reinio2020-06-041-3/+3
| | | | | | | | | | | QDoc uses a simplified method of parsing the parameters for QML methods and macros. This code had issues, resulting in parameter types being dropped from the output in certain cases. Pick-to: 5.15 Fixes: QTBUG-84364 Change-Id: I245dd423ab0583ae826594a618d85c2876543077 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* qdoc: Refactor automatic note generation for function nodesTopi Reinio2020-03-061-0/+2
| | | | | | | | | | | | | | | | | | | | Function nodes may have a number of automatically generated notes added to the documentation; as they share the same formatting, collect them into a single virtual function in Generator, and override it in DocBookGenerator. Call the virtual function in Generator::generateBody() after generating the text for the Doc instance. As we append the notes to the body, the order in which the notes appear may change slightly (if a function comment generates multiple notes). Add \note commands in the tests in preparation for a follow-up commit that utilizes the refactored code. Task-number: QTBUG-37355 Change-Id: Id92926e53b61e03a2d2feceda70987191b708975 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2020-02-181-14/+14
| | | | | Change-Id: I98eaf748fdfb34f32d187718459327b8eef9c54b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Sort the members of shared comment node collectiveTopi Reinio2020-01-241-6/+6
| | | | | | | | | Nodes sharing a comment will be listed together as a group, so sort them alphabetically. Fixes: QTBUG-81265 Change-Id: Ia8dcba92d74116bf6757bfc9aaded1c65d7271fd Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QDoc: Use html5 charset declarationPaul Wicking2020-01-051-1/+1
| | | | | | | | | | | | As we claim the html is html5 compliant (<!doctype html>), use the html5 charset declaration instead of html 4.01 style. Also, drop the trailing '/' (no need to close meta element). Update all test content to match the new output. Task-number: QTBUG-73026 Change-Id: I4cf58a342a2bfb9e76245bd3fb91525e6e59f622 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* QDoc: Drop xml prolog from html outputPaul Wicking2020-01-051-1/+0
| | | | | | | | | | The html output is not well-formed xml, so let's not claim that it is. Update expected output in tests to reflect the change in output. Task-number: QTBUG-73026 Change-Id: I0e6646eb33cafad7be543869585609d6f4cb0fdb Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Fix regression in output for QML properties with shared commentsTopi Reinio2019-12-161-25/+70
| | | | | | | | | | | | | | | | | | QDoc was incorrectly assuming that QML properties that share a comment must belong to a property group. Fix the issue, reduce duplication of code with functions that output properties and methods, fix the 'id' attributes that were left empty, and remove the <a name="..."> elements that are obsolete and unnecessary now that 'id' has correct content. Add a test for both properties and methods that share a comment, and fix the expected output data for above changes. Fixes: QTBUG-80768 Change-Id: Iddfca8214b6058987c76cd8f8dd6a842ce7cea89 Reviewed-by: Levon Sargsyan <levon.sargsyan@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Improve QDoc autotest for QML documentationTopi Reinio2019-12-061-0/+141
Fix the previous test that never generated any QML type documentation, and add new test types, documented in .cpp, .qdoc, and inline in .qml. Use all available \qml-specific QDoc commands. Fixes: QTBUG-80154 Change-Id: I60d9762836b986ca534c664517274517b73c085d Reviewed-by: Levon Sargsyan <levon.sargsyan@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-09 16:53:55 +0000