From 68967cba72b03b5d0a713204805ec5b399dd6fb1 Mon Sep 17 00:00:00 2001 From: Levon Sargsyan Date: Wed, 9 Oct 2019 15:25:45 +0200 Subject: Add new input data to test \reimp command MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The purpose of this change is to test the documentation that is generated for comments that use QDoc's \reimp command. This is done by adding a new virtual method to the Test class, and a new inherited class that implements it. Change-Id: If2367362475cc3daf31004dec43e8e15076acfb5 Reviewed-by: Levon Sargsyan Reviewed-by: Topi Reiniƶ Reviewed-by: Paul Wicking --- .../expected_output/testcpp-module.html | 1 + .../expected_output/testqdoc-test-members.html | 1 + .../expected_output/testqdoc-test.html | 8 +++- .../testqdoc-testderived-members.html | 22 ++++++++++ .../expected_output/testqdoc-testderived.html | 49 ++++++++++++++++++++++ .../generatedoutput/expected_output/testqdoc.html | 4 ++ tests/auto/qdoc/generatedoutput/testcpp.cpp | 22 ++++++++++ tests/auto/qdoc/generatedoutput/testcpp.h | 6 +++ 8 files changed, 112 insertions(+), 1 deletion(-) create mode 100644 tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived-members.html create mode 100644 tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived.html diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testcpp-module.html b/tests/auto/qdoc/generatedoutput/expected_output/testcpp-module.html index 92103d867..fc05a8d14 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testcpp-module.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testcpp-module.html @@ -31,6 +31,7 @@

Classes

+

TestQDoc::Test

A class in a namespace

TestQDoc::TestDerived

A derived class in a namespace

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 2c0b9b24f..a52123a32 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test-members.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test-members.html @@ -15,6 +15,7 @@
  • inlineFunction()
  • someFunction(int ) : int
  • someFunctionDefaultArg(int , bool )
  • +
  • virtualFun()
  • diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html index bf7ba3307..32fb9efa0 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html @@ -25,7 +25,8 @@
    Header: #include <Test> -
    qmake: QT += testcpp
      + qmake: QT += testcpp Inherited By:

      TestQDoc::TestDerived

      + @@ -35,6 +36,7 @@ void inlineFunction() int someFunction(int v) void someFunctionDefaultArg(int i, bool b = false) + virtual void virtualFun()

      Macros

      @@ -61,6 +63,10 @@

      void Test::someFunctionDefaultArg(int i, bool b = false)

      Function that takes a parameter i and b.

      + +

      [virtual] void Test::virtualFun()

      +

      Function that must be reimplemented.

      +

      Macro Documentation

      diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived-members.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived-members.html new file mode 100644 index 000000000..f5adf249c --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived-members.html @@ -0,0 +1,22 @@ + + + + + + + List of All Members for TestDerived | TestCPP + + +
    • TestDerived
    • + +

      List of All Members for TestDerived

      +

      This is the complete list of members for TestQDoc::TestDerived, including inherited members.

      + + + diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived.html new file mode 100644 index 000000000..a5478fc66 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-testderived.html @@ -0,0 +1,49 @@ + + + + + + + TestDerived Class | TestCPP + + +
    • TestDerived
    • + +

      TestDerived Class

      +(TestQDoc::TestDerived)
      + +

      A derived class in a namespace. More...

      + +
      +
      Header: #include <TestDerived> +
      qmake: QT += testcpp
      Inherits: TestQDoc::Test
      + +

      Reimplemented Public Functions

      +
      + +
      virtual void virtualFun() override
      + + +
      +

      Detailed Description

      +
      + +
      +

      Member Function Documentation

      + +

      [override virtual] void TestDerived::virtualFun()

      +

      Reimplements: Test::virtualFun().

      + +
      + + diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html index baa0d9a65..94ef710fc 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html @@ -30,6 +30,7 @@

      Classes

      +
      class Test
      class TestDerived

      Macros

      @@ -50,6 +51,9 @@

      class Test

      A class in a namespace. More...

      +

      class TestDerived

      +

      A derived class in a namespace. More...

      +

      Macro Documentation

      diff --git a/tests/auto/qdoc/generatedoutput/testcpp.cpp b/tests/auto/qdoc/generatedoutput/testcpp.cpp index 3ed4dc0bd..3277d496d 100644 --- a/tests/auto/qdoc/generatedoutput/testcpp.cpp +++ b/tests/auto/qdoc/generatedoutput/testcpp.cpp @@ -52,6 +52,12 @@ namespace TestQDoc { \brief A class in a namespace. */ +/*! + \class TestQDoc::TestDerived + \inmodule TestCPP + \brief A derived class in a namespace. +*/ + /*! \macro QDOCTEST_MACRO \relates TestQDoc @@ -117,4 +123,20 @@ int Test::someFunction(int v) \brief An inline function, documented using the \CMDFN QDoc command. */ +/*! + Function that must be reimplemented. +*/ +void Test::virtualFun() +{ + return; +} + +/*! + \reimp +*/ +void TestDerived::virtualFun() +{ + return; +} + } // namespace TestQDoc diff --git a/tests/auto/qdoc/generatedoutput/testcpp.h b/tests/auto/qdoc/generatedoutput/testcpp.h index f39b6d284..733f9e751 100644 --- a/tests/auto/qdoc/generatedoutput/testcpp.h +++ b/tests/auto/qdoc/generatedoutput/testcpp.h @@ -39,6 +39,12 @@ public: void anotherObsoleteMember(); void deprecatedMember(); inline void inlineFunction() {}; + virtual void virtualFun(); +}; + +class TestDerived : public Test { +public: + void virtualFun() override; }; } // namespace TestQDoc -- cgit v1.2.3