Remove support for test case descriptions

Closes #1189

docs/deprecations.md

@@ -11,16 +11,6 @@ at least the next major release.
 
 ## Deprecations
 
-### Secondary description amongst tags
-
-Currently, the tags part of `TEST_CASE` (and others) macro can also
-contain text that is not part of tags. This text is then separated into
-a "description" of the test case, but the description is then never used
-apart from writing it out for `--list-tests -v high`.
-
-Because it isn't actually used nor documented, and brings complications
-to Catch2's internals, description support will be removed.
-
 ### SourceLineInfo::empty()
 
 There should be no reason to ever have an empty `SourceLineInfo`, so the

docs/release-notes.md

@@ -40,6 +40,8 @@
 * `--list*` commands are now piped through the reporters
   * The top-level reporter interface provides default implementation that works just as the old one
   * XmlReporter outputs a machine-parseable XML
+* `TEST_CASE` description support has been removed
+  * If the second argument has text outside tags, the text will be ignored.
 
 ### Fixes
 * The `INFO` macro no longer contains superfluous semicolon (#1456)

examples/210-Evt-EventListeners.cpp

@@ -139,7 +139,6 @@ void print( std::ostream& os, int const level, std::string const& title, Catch::
 //
 //     std::string name;
 //     std::string className;
-//     std::string description;
 //     std::vector<std::string> tags;
 //     std::vector<std::string> lcaseTags;
 //     SourceLineInfo lineInfo;
@@ -155,7 +154,6 @@ void print( std::ostream& os, int const level, std::string const& title, Catch::
        << ws(level+1) << "- tagsAsString(): '"  << info.tagsAsString() << "'\n"
        << ws(level+1) << "- name: '"            << info.name << "'\n"
        << ws(level+1) << "- className: '"       << info.className << "'\n"
-       << ws(level+1) << "- description: '"     << info.description << "'\n"
        << ws(level+1) << "- tags: "             << info.tags << "\n"
        << ws(level+1) << "- lcaseTags: "        << info.lcaseTags << "\n";
     print( os, level+1 , "- lineInfo", info.lineInfo );

include/internal/catch_interfaces_reporter.cpp

@@ -157,10 +157,6 @@ namespace Catch {
             Catch::cout() << Column(testCaseInfo.name).initialIndent(2).indent(4) << '\n';
             if (config.verbosity() >= Verbosity::High) {
                 Catch::cout() << Column(Catch::Detail::stringify(testCaseInfo.lineInfo)).indent(4) << std::endl;
-                std::string description = testCaseInfo.description;
-                if (description.empty())
-                    description = "(NO DESCRIPTION)";
-                Catch::cout() << Column(description).indent(4) << std::endl;
             }
             if (!testCaseInfo.tags.empty() && config.verbosity() > Verbosity::Quiet) {
                 Catch::cout() << Column(testCaseInfo.tagsAsString()).indent(6) << '\n';

include/internal/catch_test_case_info.cpp

@@ -57,16 +57,14 @@ namespace Catch {
 
         // Parse out tags
         std::vector<std::string> tags;
-        std::string desc, tag;
+        std::string tag;
         bool inTag = false;
         for (char c : nameAndTags.tags) {
             if( !inTag ) {
-                if( c == '[' )
+                if (c == '[') {
                     inTag = true;
-                else
-                    desc += c;
-            }
-            else {
+                }
+            } else {
                 if( c == ']' ) {
                     TestCaseInfo::SpecialProperties prop = parseSpecialTag( tag );
                     if( ( prop & TestCaseInfo::IsHidden ) != 0 )
@@ -92,7 +90,7 @@ namespace Catch {
             tags.push_back( "." );
         }
 
-        TestCaseInfo info( static_cast<std::string>(nameAndTags.name), _className, desc, tags, _lineInfo );
+        TestCaseInfo info( static_cast<std::string>(nameAndTags.name), _className, tags, _lineInfo );
         return TestCase( _testCase, std::move(info) );
     }
 
@@ -111,12 +109,10 @@ namespace Catch {
 
     TestCaseInfo::TestCaseInfo( std::string const& _name,
                                 std::string const& _className,
-                                std::string const& _description,
                                 std::vector<std::string> const& _tags,
                                 SourceLineInfo const& _lineInfo )
     :   name( _name ),
         className( _className ),
-        description( _description ),
         lineInfo( _lineInfo ),
         properties( None )
     {

include/internal/catch_test_case_info.h

@@ -37,7 +37,6 @@ namespace Catch {
 
         TestCaseInfo(   std::string const& _name,
                         std::string const& _className,
-                        std::string const& _description,
                         std::vector<std::string> const& _tags,
                         SourceLineInfo const& _lineInfo );
 
@@ -52,7 +51,6 @@ namespace Catch {
 
         std::string name;
         std::string className;
-        std::string description;
         std::vector<std::string> tags;
         std::vector<std::string> lcaseTags;
         SourceLineInfo lineInfo;

include/reporters/catch_reporter_xml.cpp

@@ -73,7 +73,6 @@ namespace Catch {
         StreamingReporterBase::testCaseStarting(testInfo);
         m_xml.startElement( "TestCase" )
             .writeAttribute( "name", trim( testInfo.name ) )
-            .writeAttribute( "description", testInfo.description )
             .writeAttribute( "tags", testInfo.tagsAsString() );
 
         writeSourceInfo( testInfo.lineInfo );
@@ -289,9 +288,6 @@ namespace Catch {
             m_xml.startElement("ClassName", XmlFormatting::Indent)
                  .writeText(testInfo.className, XmlFormatting::None)
                  .endElement(XmlFormatting::Newline);
-            m_xml.startElement("Description", XmlFormatting::Indent)
-                 .writeText(testInfo.description, XmlFormatting::None)
-                 .endElement(XmlFormatting::Newline);
             m_xml.startElement("Tags", XmlFormatting::Indent)
                  .writeText(testInfo.tagsAsString(), XmlFormatting::None)
                  .endElement(XmlFormatting::Newline);