From 1bada8a3cf8b0a3f5660c0a7f92b2f501c11dea8 Mon Sep 17 00:00:00 2001 From: Paul Wicking Date: Fri, 30 Apr 2021 09:53:34 +0000 Subject: Revert "QDoc: Add \deprecatedsince command" 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 --- .../crossmodule/testtype-members.html | 1 - .../expected_output/docbook/qml-qdoc-test-type.xml | 5 ---- .../expected_output/docbook/testqdoc-test.xml | 32 +++++++++++----------- .../expected_output/dontdocument/dontdocument.qhp | 2 +- .../expected_output/html/testqdoc-test.webxml | 2 +- .../expected_output/ignoresince/testqdoc-test.html | 6 ---- .../expected_output/properties/testcpp.index | 2 +- .../properties/testqdoc-testderived-members.html | 1 - .../qml-qdoc-test-type-members.html | 1 - .../expected_output/qml-qdoc-test-type.html | 12 -------- .../scopedenum-docbook/testqdoc-test.xml | 32 +++++++++++----------- .../expected_output/scopedenum/testqdoc-test.html | 6 ---- .../expected_output/template/testqdoc-test.html | 6 ---- .../qdoc/generatedoutput/expected_output/test.qhp | 3 +- .../generatedoutput/expected_output/testcpp.index | 2 +- .../expected_output/testqdoc-test-members.html | 1 - .../expected_output/testqdoc-test.html | 6 ---- .../testqdoc-testderived-members.html | 1 - .../expected_output/testtagfile.tags | 9 +----- .../qdoc/generatedoutput/testdata/qml/type.cpp | 10 ------- .../generatedoutput/testdata/testcpp/testcpp.cpp | 1 - 21 files changed, 38 insertions(+), 103 deletions(-) (limited to 'tests/auto/qdoc/generatedoutput') diff --git a/tests/auto/qdoc/generatedoutput/expected_output/crossmodule/testtype-members.html b/tests/auto/qdoc/generatedoutput/expected_output/crossmodule/testtype-members.html index 5ba62546d..0a32e4e60 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/crossmodule/testtype-members.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/crossmodule/testtype-members.html @@ -15,7 +15,6 @@
  • NotTypedef
  • SomeType
  • operator=(TestQDoc::Test &&) : TestQDoc::Test &
    • -
  • deprecatedMember()
  • funcPtr(bool, const char *) : void (*)(bool)
  • inlineFunction()
  • nothing()
    • diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml index 1f33b622d..e54487b53 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml @@ -165,10 +165,5 @@ Type copy(a) Returns another Type based on a. - -deprecatedMethod() -This method is deprecated since 6.2. -This is a method that should include information about being deprecated and that it has been so since 6.2 in its docs. - diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml index 36195c715..724e827f9 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml @@ -94,22 +94,6 @@ Move-assigns other. - -Test::void deprecatedMember() - - -deprecatedMember - -plain -void deprecatedMember() -public -deprecated -unspecified -TestCPP - -This function is deprecated since 6.0. -Use someFunction() instead. - Test::void (*)(bool) funcPtr(bool b, const char *s) @@ -277,6 +261,22 @@ This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code. Use obsoleteMember() instead. + +Test::void deprecatedMember() + + +deprecatedMember + +plain +void deprecatedMember() +public +obsolete +unspecified +TestCPP + +This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code. +Use someFunction() instead. + Test::void obsoleteMember() diff --git a/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp b/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp index de0ae3994..c83440461 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp +++ b/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp @@ -34,7 +34,7 @@ - + diff --git a/tests/auto/qdoc/generatedoutput/expected_output/html/testqdoc-test.webxml b/tests/auto/qdoc/generatedoutput/expected_output/html/testqdoc-test.webxml index 0e832e235..949949ee9 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/html/testqdoc-test.webxml +++ b/tests/auto/qdoc/generatedoutput/expected_output/html/testqdoc-test.webxml @@ -21,7 +21,7 @@ Use obsoleteMember() instead. - + Use someFunction() instead. diff --git a/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html index c3b353e6a..007f635e3 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html @@ -41,7 +41,6 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest) - @@ -88,11 +87,6 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
    Test()
    TestQDoc::Test &operator=(TestQDoc::Test &&other)
    (deprecated (6.0)) void deprecatedMember()
    void (*)(bool) funcPtr(bool b, const char *s)
    void inlineFunction()
    int someFunction(int, int v = 0)
    [default] TestQDoc::Test &Test::operator=(TestQDoc::Test &&other)

    Move-assigns other.

    - -

    void Test::deprecatedMember()

    -

    This function is deprecated since 6.0.

    -

    Use someFunction() instead.

    -

    void (*)(bool) Test::funcPtr(bool b, const char *s)

    Returns a pointer to a function that takes a boolean. Uses b and s.

    diff --git a/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index b/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index index 7599cce6e..853085e49 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index +++ b/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index @@ -23,7 +23,7 @@ - + diff --git a/tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived-members.html b/tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived-members.html index 3d7f190b7..44ac132be 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived-members.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived-members.html @@ -25,7 +25,6 @@
  • bindableProp() : QBindable<QString>
  • boolProp() : bool
      • -
    • deprecatedMember()
    • funcPtr(bool, const char *) : void (*)(bool)
    • getInt() : int *
    • inlineFunction()
      • diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type-members.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type-members.html index 760be8801..368bd367d 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type-members.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type-members.html @@ -24,7 +24,6 @@
    • completed(int status)
    • configured() [attached]
    • Type copy(a)
      • -
    • deprecatedMethod() (deprecated since 6.2)
    • disable()
    • enable()
    • group.created()
      • diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html index 31590dbc6..bd8fb93e5 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html @@ -57,7 +57,6 @@

      Methods

      @@ -190,16 +189,5 @@

      Returns another Type based on a.


      - -
      -
      - - -

      -deprecatedMethod()

      -

      This method is deprecated since 6.2.

      -

      This is a method that should include information about being deprecated and that it has been so since 6.2 in its docs.

      -
      -
      diff --git a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml index ab10297d1..f7cee4513 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml @@ -190,22 +190,6 @@ Move-assigns other. - -Test::void deprecatedMember() - - -deprecatedMember - -plain -void deprecatedMember() -public -deprecated -unspecified -TestCPP - -This function is deprecated since 6.0. -Use someFunction() instead. - Test::void (*)(bool) funcPtr(bool b, const char *s) @@ -373,6 +357,22 @@ This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code. Use obsoleteMember() instead. + +Test::void deprecatedMember() + + +deprecatedMember + +plain +void deprecatedMember() +public +obsolete +unspecified +TestCPP + +This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code. +Use someFunction() instead. + Test::void obsoleteMember() diff --git a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html index 0f02ebad7..00523f7a6 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html @@ -43,7 +43,6 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
    - @@ -107,11 +106,6 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
    Test()
    TestQDoc::Test &operator=(TestQDoc::Test &&other)
    (deprecated (6.0)) void deprecatedMember()
    void (*)(bool) funcPtr(bool b, const char *s)
    void inlineFunction()
    int someFunction(int, int v = 0)
    [default] TestQDoc::Test &Test::operator=(TestQDoc::Test &&other)

    Move-assigns other.

    - -

    void Test::deprecatedMember()

    -

    This function is deprecated since 6.0.

    -

    Use someFunction() instead.

    -

    void (*)(bool) Test::funcPtr(bool b, const char *s)

    Returns a pointer to a function that takes a boolean. Uses b and s.

    diff --git a/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html index 1b14ecb1e..4e326198c 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html @@ -43,7 +43,6 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
    - @@ -94,11 +93,6 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
    Test()
    TestQDoc::Test &operator=(TestQDoc::Test &&other)
    (deprecated (6.0)) void deprecatedMember()
    void (*)(bool) funcPtr(bool b, const char *s)
    void inlineFunction()
    int someFunction(int, int v = 0)
    [default] TestQDoc::Test &Test::operator=(TestQDoc::Test &&other)

    Move-assigns other.

    - -

    void Test::deprecatedMember()

    -

    This function is deprecated since 6.0.

    -

    Use someFunction() instead.

    -

    void (*)(bool) Test::funcPtr(bool b, const char *s)

    Returns a pointer to a function that takes a boolean. Uses b and s.

    diff --git a/tests/auto/qdoc/generatedoutput/expected_output/test.qhp b/tests/auto/qdoc/generatedoutput/expected_output/test.qhp index 92c7a2453..4fffda513 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/test.qhp +++ b/tests/auto/qdoc/generatedoutput/expected_output/test.qhp @@ -100,8 +100,7 @@ - - + diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index b/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index index 7c540f2ea..9f17e95d0 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index +++ b/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index @@ -22,7 +22,7 @@ - + diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test-members.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test-members.html index e96d99f9e..df0da4386 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test-members.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test-members.html @@ -14,7 +14,6 @@
  • SomeType
  • Test()
  • operator=(TestQDoc::Test &&) : TestQDoc::Test &
    • -
  • deprecatedMember()
  • funcPtr(bool, const char *) : void (*)(bool)
  • inlineFunction()
  • overload()
    • diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html index 100feced8..3146291ce 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html @@ -41,7 +41,6 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
    - @@ -88,11 +87,6 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
    Test()
    TestQDoc::Test &operator=(TestQDoc::Test &&other)
    (deprecated (6.0)) void deprecatedMember()
    void (*)(bool) funcPtr(bool b, const char *s)
    void inlineFunction()
    int someFunction(int, int v = 0)
    [default] TestQDoc::Test &Test::operator=(TestQDoc::Test &&other)

    Move-assigns other.

    - -

    void Test::deprecatedMember()

    -

    This function is deprecated since 6.0.

    -

    Use someFunction() instead.

    -

    void (*)(bool) Test::funcPtr(bool b, const char *s)

    Returns a pointer to a function that takes a boolean. Uses b and s.

    diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived-members.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived-members.html index 7cdc03bcc..f8f9cd8f7 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived-members.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived-members.html @@ -15,7 +15,6 @@
  • NotTypedef
  • SomeType
  • operator=(TestQDoc::Test &&) : TestQDoc::Test &
    • -
  • deprecatedMember()
  • funcPtr(bool, const char *) : void (*)(bool)
  • inlineFunction()
  • overload()
    • diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testtagfile.tags b/tests/auto/qdoc/generatedoutput/expected_output/testtagfile.tags index 66a2888d2..1e9a28a59 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testtagfile.tags +++ b/tests/auto/qdoc/generatedoutput/expected_output/testtagfile.tags @@ -161,7 +161,7 @@ void deprecatedMember - testqdoc-test.html + testqdoc-test-obsolete.html deprecatedMember () @@ -305,13 +305,6 @@ configured-signal () - - - deprecatedMethod - qml-qdoc-test-type.html - deprecatedMethod-method - () - QDoc.Test.YetAnotherChild diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp index cce74f18f..3dc83d39c 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp +++ b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp @@ -117,13 +117,3 @@ This attached signal is emitted when the type was configured. */ - -/*! - \qmlmethod Type::deprecatedMethod() - - \deprecated - \deprecatedsince 6.2 - - This is a method that should include information about being deprecated - and that it has been so since 6.2 in its docs. -*/ diff --git a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp index 7e3f8f24a..51ae743db 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp +++ b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp @@ -110,7 +110,6 @@ namespace TestQDoc { /*! \deprecated - \deprecatedsince 6.0 Use someFunction() instead. */ -- cgit v1.2.1