aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/generator/qtdoc/qtxmltosphinx.cpp
Commit message (Collapse)AuthorAgeFilesLines
* shiboken6/doc generator: Extract method to resolve links to ↵Friedemann Kleint2021-06-251-51/+54
| | | | | | | | | | | | | | QtXmlToSphinxDocGeneratorInterface Extract the private struct LinkContext to a public struct QtXmlToSphinxLink with debug operator and add a resolve method to QtXmlToSphinxDocGeneratorInterface. Task-number: PYSIDE-1112 Change-Id: I91b3bc45ebc530394a3e77c56b05dd5b740e8985 Reviewed-by: Christian Tismer <tismer@stackless.com> (cherry picked from commit 991cfb9376275e1ab259f0a9b95302bc56ba7127) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* shiboken6/doc generator: Fix tables nested in paragraphsFriedemann Kleint2021-06-251-19/+48
| | | | | | | | | | | | | Tables embedded within paragraphs were broken since they were rst-escaped and newlines simplified by the </para> handling. To fix this, end the <para> when a <table> is encountered and restart again afterwards. Task-number: PYSIDE-1112 Change-Id: I2d97d8bfd9f1a838853c58b6a657aa9e4cf719e6 Reviewed-by: Christian Tismer <tismer@stackless.com> (cherry picked from commit 9a7f4732c3bd0758fe3a47ff7022a2fbcf4d2dcf) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* shiboken6: Small refactoring of QtXmlToSphinxFriedemann Kleint2021-06-241-11/+8
| | | | | | | | | | - Use member initialization - Use QSharedPointer in the buffer stack Change-Id: Ib6a9aeab422c414a073140a401593c06c119cdbe Reviewed-by: Christian Tismer <tismer@stackless.com> (cherry picked from commit c5a8cad30b7b800e83e22e39bfa257871e28572a) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* shiboken6/Doc generator: Fix continuation dots in code snippetsFriedemann Kleint2021-06-191-3/+3
| | | | | | | | | | Properly indent them after ::. Fixes a number of sphinx warnings about "Unexpected indentation" in data visualization examples. Change-Id: I5ebf2df629dda5fba86b7e25a320cbe89e7dfb8b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 2e573af438e440bb2041370d99b2a2e0147ea65d) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* shiboken6/Doc generator: Dedent documentation code snippetsFriedemann Kleint2021-06-191-2/+3
| | | | | | | | | | | | | | Split out helpers for fixing code snippets from class CodeSnipAbstract (which is necessary since the QtXmlToSphinx test is compiled from single source files) and use them. Fixes a number of sphinx warnings about "Unexpected indentation" in data visualization examples. Change-Id: I109f5f6a8158689f5c966630f1b29d797b48607d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 772f117d30c567c397944d62c9084360bb071d83) Reviewed-by: Christian Tismer <tismer@stackless.com>
* shiboken6/Doc generator: Fix HTTP URLs in documentationFriedemann Kleint2021-06-181-5/+8
| | | | | | | | | | | Always use as "external", do not reformat them as RST labels. Fixes for example the link to the Sinclair ZX Spectrum page in the QLCDnumber documentation, which appeared as WebXML link tag and was reformatted. Change-Id: Ibf0195365488979bdfd3e08cdd59e77860ac30f6 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 705b80e6a427ac9d27e0e1911e1bdcfb17634b12) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* shiboken6: Fix broken tables in the QLocale documentationFriedemann Kleint2021-02-111-1/+1
| | | | | | | | | Add a newline before the enumeration table. Pick-to: 6.0 Task-number: PYSIDE-841 Change-Id: I83e81983dd7139c120480cba859e1683a4721c92 Reviewed-by: Christian Tismer <tismer@stackless.com>
* shiboken6/Documentation: Fix table width determinationFriedemann Kleint2021-02-081-3/+3
| | | | | | | | | | Initialize the width/height lists to 0. As a drive-by, use the number of lines from splitting instead of counting. Pick-to: 6.0 Change-Id: Ib17ed819684298599d3c01cf00cfc8b5c192d232 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6: Make more functions static using clang tidyFriedemann Kleint2021-01-231-1/+1
| | | | | | | | | Apply the fix created by clang tidy' -wreadability-convert-member-functions-to-static warning with some manual correction. Change-Id: I394bd96881fa25dbcb7a725b79d10395fcbb8676 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Shiboken6: Decouple QtXmlToSphinx from the doc generatorFriedemann Kleint2020-12-151-133/+85
| | | | | | | | | | | | | To enable testing, decouple QtXmlToSphinx from the doc generator by introducing a parameter struct QtXmlToSphinxParameters and an interface QtXmlToSphinxDocGeneratorInterface. Move the messages back into qtxmltosphinx.cpp and move the helper function convertToRst to the doc generator since it uses FileOut. Pick-to: 6.0 Change-Id: I176888dcbd65003856ea8797a5629949598801d5 Reviewed-by: Christian Tismer <tismer@stackless.com>
* shiboken6: Remove unused attribute from qtxmltosphinx.cppFriedemann Kleint2020-12-081-1/+0
| | | | | Change-Id: Icf83ad1a2d4784dd09b4bba16093b2f67c2e77da Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6: Store AbstractMetaFunction using a QSharedPointerFriedemann Kleint2020-11-301-4/+4
| | | | | | | | | | | | | | | | | | Store the list functions (global / class member) as a QList<QSharedPointer<const AbstractMetaFunction> instead of a raw pointer list. This makes passing around function lists easier and solves the memory leaks caused by mixing cloned and unmodified functions while collecting the overload lists in the generators. - Change the function signatures accordingly - Add a qSharedPointerConstCast() for non-const access. - Restructure the traversing of added functions in the AbstractMetaBuilder - Remove some unused typedefs and functions unearthed by the change Change-Id: I08a6c5243750e3eb3813bc3f7172899ad2b13e22 Reviewed-by: Christian Tismer <tismer@stackless.com>
* shiboken6: Replace handler map in QtXmlToSphinx by an enumerationFriedemann Kleint2020-11-301-81/+238
| | | | | | | | | | | Constructing the strings and populating a hash with function pointers for each invocation on a snippet is wasteful. Introduce an enum, populate a constant static hash with it and dispatch the call via switch. Change-Id: Ia8e0123fc31802c35b33308edb0fa9edc6add775 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6: Port QtDocGenerator to the new text streamFriedemann Kleint2020-11-261-97/+65
| | | | | | | Finally remove the old indentor. Change-Id: I25150f61f914c1a6adc13341057a94c8bd281296 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6: Split out the QtXmlToSphinx formatter from the doc generatorFriedemann Kleint2020-11-251-0/+1312
Change-Id: I9b8ef4c53234d107e394c0a1396c8ed00768d722 Reviewed-by: Christian Tismer <tismer@stackless.com>