aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/ApiExtractor/classdocumentation.cpp
Commit message (Collapse)AuthorAgeFilesLines
* shiboken/Documentation: Remove more C++ -specific sections from the WebXML ↵Friedemann Kleint2024-12-171-4/+7
| | | | | | | | | | | module descriptions Complements 9bd0967d9b3f38ea7959fb00aa28a5ee1a1d0932. Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: I414d4bf672a61f4e54720ea7ef6f6706a4e09329 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* shiboken/Documentation: Remove C++ -specific sections from the WebXML module ↵Friedemann Kleint2024-12-131-1/+33
| | | | | | | | | | | | | descriptions Read the description into a QByteArray and remove C++ -specific sections. This applies to modules for which PySide does not have a description file. Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: I170fc155a94f45778331b820614dd2e34f10867f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6: Add a documentation file hint to complex type entriesFriedemann Kleint2024-11-281-17/+25
| | | | | | | | | | | | | | | | | | | | Complements ad5eb64daaaa1b927bcbf9e568738f417fef845f. Add a doc-file attribute to complex type entries (object/value/namespaces) like it was done for enums and free functions by ad5eb64daaaa1b927bcbf9e568738f417fef845f. This is mainly intended for namespaces that can be extended by other modules. Change the functions to parse WebXML to accept lists of files. Improve the error message about not finding qdoc files. Pick-to: 6.8 Task-number: PYSIDE-2918 Task-number: PYSIDE-1106 Change-Id: I2811e0715b7f44a4461876019580295f5af4ea06 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Use function parameter names from WebXML/qdoc when they are ↵Friedemann Kleint2024-11-211-2/+5
| | | | | | | | | | | | missing In some cases, the Qt headers do not have parameter names. Use the ones from the WebXML documents in that case. Pick-to: 6.8 Task-numer: PYSIDE-1106 Change-Id: I719a4fb09b9fbef9fc734036e3f53c02376a5d5f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6: Fix ODR violation / duplicated enum nameFriedemann Kleint2024-02-291-30/+30
| | | | | | | | | | enum WebXmlTag was duplicated in classdocumentation.cpp and qtxmltosphinx.cpp. Task-number: PYSIDE-2619 Pick-to: 6.6 Change-Id: I287bdcba769e9333ccf996a946a767f296045c60 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Adapt struct ClassDocumentation for header documentsFriedemann Kleint2023-12-191-14/+17
| | | | | | | | | | | Global functions and enumeration appear as WebXml documents with a <header> element instead of class <class>. Extend the ClassDocumentation and its parse to represent that. Change the parsing to return an optional and remove the operator bool. Task-number: PYSIDE-1106 Change-Id: I2e0413904dd8a5859aa9ed2aea9522aa5f24e939 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* shiboken6/generator: Fix CMake UNITY_BUILD (jumbo)Friedemann Kleint2022-12-161-16/+2
| | | | | | | | - Use a string literal for "::" - Add a header for debug helpers Change-Id: I605a00fea1b936032afa93d9be45b7da31d42473 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6: Store the property documentation in QPropertySpecFriedemann Kleint2022-11-241-0/+1
| | | | | | | | | | | | Similar to AbstractMetaFunction and AbstractMetaClass, store the documentation (brief/detail) in QPropertySpec. Task-number: PYSIDE-1106 Task-number: PYSIDE-1019 Pick-to: 6.4 Change-Id: Ide236b5918c135e331149ca384ed973fd794b55f Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Purge remaining uses of old Qt string literalsFriedemann Kleint2022-11-221-8/+10
| | | | | | | | | | Amends a3e882b06eda8f9a63cf3834a99640034775269b. Pick-to: 6.4 Task-number: QTBUG-98434 Change-Id: I23ad60d6e4201aa2d8dbf3fa8892d3df3c56c5fc Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Use SPDX license identifiersLucie Gérard2022-05-271-27/+2
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: I065150015bdb84a3096b5b39c061cf0a20ab637d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6/Documentation: Replace XPath/Xquery usage for retrieving WebXML ↵Friedemann Kleint2021-12-161-0/+414
docs by a parser shiboken used XPath expressions to extract the function descriptions from the qdoc-generated WebXML. With the deprecation of QtXmlPatterns in Qt 6, libxml/xslt was used for this. A major drawback is that libxml/xslt is unable to match entities in attributes which means functions taking parameters by const-ref could not be found. This required cumbersome workarounds involving repeated searches, which still were not sufficient to find all functions. To fix this, write a WebXML parser based on QXmlStreamReader that extracts the contents of a WebXML page into some simple data structures and use those for searching. On this occasion, also use the metafunction flags to correctly match binary operator functions. This reduces the number of functions for which no documentation can be found (from ~1100 to ~800 for the qtbase repository). From the remaining functions, ~230 are functions inherited from templates, which should at least be listed. Others are caused by qdoc not finding hidden friends. The remaining usages of libxml/xslt are the doxygen parser and the documentation modifications using XSLT. Task-number: PYSIDE-1106 Change-Id: I31c045ad42948afad884f40d5bbc8bee7555859e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-17 08:25:56 +0000