support throw symbols

#feat
cppalliance · Jan 3, 2025 · 4a28558 · 4a28558
1 parent 741047c
commit 4a28558
Show file tree

Hide file tree

Showing 12 changed files with 96 additions and 32 deletions.
diff --git a/include/mrdocs/Metadata/Javadoc.hpp b/include/mrdocs/Metadata/Javadoc.hpp
@@ -683,7 +683,7 @@ struct TParam : Paragraph
 */
 struct Throws : Paragraph
 {
-    String exception;
+    Reference exception;
 
     static constexpr Kind static_kind = Kind::throws;
 

diff --git a/src/lib/AST/ParseJavadoc.cpp b/src/lib/AST/ParseJavadoc.cpp
@@ -1143,28 +1143,14 @@ visitBlockCommandComment(
         doc::Throws throws;
         auto scope = enterScope(throws);
         visitChildren(C->getParagraph());
-        // KRYSTIAN NOTE: clang doesn't consider these commands
-        // to have any arguments, so we have to extract the exception
-        // type manually
-        if(! throws.children.empty())
+        if (C->getNumArgs())
         {
-            // string will start with a non-whitespace character
-            doc::String& text =
-                throws.children.front()->string;
-            constexpr char ws[] = " \t\n\v\f\r";
-            const auto except_end = text.find_first_of(ws);
-            throws.exception = text.substr(0, except_end);
-            // find the start of the next word, ignoring whitespace
-            const auto word_start =
-                text.find_first_not_of(ws, except_end);
-            // if we ran out of string, remove this block
-            if(word_start == doc::String::npos)
-                throws.children.erase(throws.children.begin());
-            // otherwise, trim the string to exclude the argument
-            else
-                text.erase(0, word_start);
+            throws.exception.string = C->getArgText(0);
+        }
+        else
+        {
+            throws.exception.string = "undefined";
         }
-
         jd_.emplace_back(std::move(throws));
         return;
     }

diff --git a/src/lib/Gen/hbs/HandlebarsCorpus.cpp b/src/lib/Gen/hbs/HandlebarsCorpus.cpp
@@ -80,7 +80,7 @@ domCreate(
     const HandlebarsCorpus& corpus)
 {
     dom::Object::storage_type entries = {
-        { "exception", I.exception }
+        { "exception", I.exception.string }
     };
     std::string s = corpus.toStringFn(corpus, I);
     if (!s.empty())

diff --git a/test-files/golden-tests/core/libcxx.adoc b/test-files/golden-tests/core/libcxx.adoc
@@ -64,8 +64,8 @@ This function calculates the square root of a    given integral value using bit
 |===
 | Name | Thrown on
 
-| `if`
-| the input value is negative&period;
+| `std&colon;&colon;invalid&lowbar;argument`
+| if the input value is negative&period;
 
 
 |===

diff --git a/test-files/golden-tests/core/libcxx.html b/test-files/golden-tests/core/libcxx.html
@@ -79,8 +79,8 @@ <h3>Exceptions</h3>
 </thead>
 <tbody>
 <tr>
-<td><code>if</code></td>
-<td><p><span>the input value is negative.</span></p>
+<td><code>std::invalid_argument</code></td>
+<td><p><span>if the input value is negative.</span></p>
 </td>
 </tr>
 </tbody>

diff --git a/test-files/golden-tests/core/libcxx.xml b/test-files/golden-tests/core/libcxx.xml
@@ -22,7 +22,7 @@
           <text>This function calculates the square root of a    given integral value using bit manipulation.</text>
         </para>
         <throws>
-          <text>the input value is negative.</text>
+          <text>if the input value is negative.</text>
         </throws>
         <tparam name="T">
           <text>The type of the input value. Must be an integral type.    </text>

diff --git a/test-files/golden-tests/javadoc/throw.adoc b/test-files/golden-tests/javadoc/throw.adoc
@@ -0,0 +1,54 @@
+= Reference
+:mrdocs:
+
+[#index]
+== Global namespace
+
+
+=== Functions
+
+[cols=2]
+|===
+| Name | Description 
+
+| <<f,`f`>> 
+| brief
+
+
+
+|===
+
+[#f]
+== f
+
+
+brief
+
+
+
+=== Synopsis
+
+
+Declared in `&lt;throw&period;cpp&gt;`
+
+[source,cpp,subs="verbatim,replacements,macros,-callouts"]
+----
+void
+f();
+----
+
+=== Exceptions
+
+
+|===
+| Name | Thrown on
+
+| `std&colon;&colon;length&lowbar;error`
+| `dest&lowbar;size &lt; ipv4&lowbar;address&colon;&colon;max&lowbar;str&lowbar;len`
+
+
+|===
+
+
+
+[.small]#Created with https://www.mrdocs.com[MrDocs]#
diff --git a/test-files/golden-tests/javadoc/throw.cpp b/test-files/golden-tests/javadoc/throw.cpp
@@ -0,0 +1,5 @@
+/** brief
+
+    @throw std::length_error `dest_size < ipv4_address::max_str_len`
+ */
+void f();
diff --git a/test-files/golden-tests/metadata/overloads.cpp b/test-files/golden-tests/metadata/overloads.cpp
@@ -0,0 +1,19 @@
+struct A {
+    void f();
+    int f(int);
+
+    static void g();
+    static int g(int);
+
+    friend bool operator==(A, A);
+    friend bool operator==(A, int);
+};
+
+void f();
+int f(int);
+
+struct B {};
+
+bool operator==(B, B);
+bool operator==(B, int);
+
diff --git a/test-files/golden-tests/snippets/sqrt.adoc b/test-files/golden-tests/snippets/sqrt.adoc
@@ -64,8 +64,8 @@ This function calculates the square root of a    given integral value using bit
 |===
 | Name | Thrown on
 
-| `if`
-| the input value is negative&period;
+| `std&colon;&colon;invalid&lowbar;argument`
+| if the input value is negative&period;
 
 
 |===

diff --git a/test-files/golden-tests/snippets/sqrt.html b/test-files/golden-tests/snippets/sqrt.html
@@ -79,8 +79,8 @@ <h3>Exceptions</h3>
 </thead>
 <tbody>
 <tr>
-<td><code>if</code></td>
-<td><p><span>the input value is negative.</span></p>
+<td><code>std::invalid_argument</code></td>
+<td><p><span>if the input value is negative.</span></p>
 </td>
 </tr>
 </tbody>

diff --git a/test-files/golden-tests/snippets/sqrt.xml b/test-files/golden-tests/snippets/sqrt.xml
@@ -22,7 +22,7 @@
           <text>This function calculates the square root of a    given integral value using bit manipulation.</text>
         </para>
         <throws>
-          <text>the input value is negative.</text>
+          <text>if the input value is negative.</text>
         </throws>
         <tparam name="T">
           <text>The type of the input value. Must be an integral type.    </text>