summaryrefslogtreecommitdiffstats
path: root/tests/auto/qdoc/generatedoutput/testdata
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-06-06 12:30:22 +0200
committerTopi Reinio <topi.reinio@qt.io>2020-06-08 16:31:16 +0200
commit58902fbd684d39191fbddf3ef5e917e709b38a68 (patch)
tree930157c38ec390ad164bea408057a999b4ae73fc /tests/auto/qdoc/generatedoutput/testdata
parent41c601103dd2fef14e59a120e142008f8e3e93cd (diff)
qdoc: Extend synopsis for detailed reference sections
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>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/testdata')
-rw-r--r--tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/parent.qdoc10
-rw-r--r--tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/qmlpropertygroups.qdocconf9
-rw-r--r--tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp6
3 files changed, 22 insertions, 3 deletions
diff --git a/tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/parent.qdoc b/tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/parent.qdoc
index c7002e96b..e0d716225 100644
--- a/tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/parent.qdoc
+++ b/tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/parent.qdoc
@@ -40,6 +40,16 @@
*/
/*!
+ \qmlproperty int Parent::group.b
+ \readonly
+*/
+
+/*!
+ \qmlproperty int Parent::group.c
+ \since 2.0
+*/
+
+/*!
\qmltype AnotherChild
\inqmlmodule QDoc.Test
\inherits Parent
diff --git a/tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/qmlpropertygroups.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/qmlpropertygroups.qdocconf
index 62952b429..713b5d6d5 100644
--- a/tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/qmlpropertygroups.qdocconf
+++ b/tests/auto/qdoc/generatedoutput/testdata/qmlpropertygroups/qmlpropertygroups.qdocconf
@@ -2,5 +2,10 @@ include(../configs/testqml.qdocconf)
sourcedirs += .
-HTML.nosubdirs = true
-HTML.outputsubdir = qmlpropertygroups
+outputformats = HTML DocBook
+
+{HTML.nosubdirs,DocBook.nosubdirs} = true
+HTML.outputsubdir = qmlpropertygroups
+DocBook.outputsubdir = qmlpropertygroups-docbook
+
+warninglimit += 2
diff --git a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp
index de8a9e4ec..835b85336 100644
--- a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp
+++ b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp
@@ -171,7 +171,6 @@ void TestDerived::virtualFun()
/*!
\fn TestQDoc::Test::overload()
\fn Test::overload(bool b)
- \since Test 1.2
//! The second overload should match even without the fully qualified path
Overloads that share a documentation comment, optionally taking
@@ -179,6 +178,11 @@ void TestDerived::virtualFun()
*/
/*!
+ \fn Test::overload(bool b)
+ \since Test 1.2
+*/
+
+/*!
\typealias TestDerived::DerivedType
An aliased typedef.
*/