virtuald · Oct 23, 2026 · Oct 23, 2026
diff --git a/tests/corpus/compat_ampersands.txt b/tests/corpus/compat_ampersands.txt
@@ -0,0 +1,3 @@
+&notanentity &copy &amp &lt &unknown;
+================================================================================
+&notanentity &copy &amp &lt &unknown;
diff --git a/tests/corpus/compat_cpp_references.txt b/tests/corpus/compat_cpp_references.txt
@@ -0,0 +1,9 @@
+AddRequirements({&subsystem1, &subsystem2})
+zhash_put(zh, &key, &val, &old_key, &old_value)
+\copydetails DenseBase::operator=(const EigenBase<OtherDerived> &other)
+DerivedT &operator=(const DerivedT &R);
+================================================================================
+AddRequirements({&subsystem1, &subsystem2})
+zhash_put(zh, &key, &val, &old_key, &old_value)
+\copydetails DenseBase::operator=(const EigenBase<OtherDerived> &other)
+DerivedT &operator=(const DerivedT &R);
diff --git a/tests/corpus/compat_cpp_templates.txt b/tests/corpus/compat_cpp_templates.txt
@@ -0,0 +1,3 @@
+std::vector<code> is valid.
+================================================================================
+std::vector<code> is valid.
diff --git a/tests/corpus/compat_incomplete_template.txt b/tests/corpus/compat_incomplete_template.txt
@@ -0,0 +1,3 @@
+std::vector<T
+================================================================================
+std::vector<T
diff --git a/tests/corpus/compat_inline_literals.txt b/tests/corpus/compat_inline_literals.txt
@@ -0,0 +1,27 @@
+Use {@code <code>value</code>} here.
+Use {@code <a href="x">text</a>} here.
+Use {@code <table><tr><td>value</td></tr></table>} here.
+Use {@code std::vector<T} here.
+Use {@code a &copy; b &other} here.
+Use {@code <!-- text -->} here.
+
+Use ``<code>value</code>`` here.
+Use ``<a href="x">text</a>`` here.
+Use ``<table><tr><td>value</td></tr></table>`` here.
+Use ``std::vector<T`` here.
+Use ``a &copy; b &other`` here.
+Use ``<!-- text -->`` here.
+================================================================================
+Use ``<code>value</code>`` here.
+Use ``<a href="x">text</a>`` here.
+Use ``<table><tr><td>value</td></tr></table>`` here.
+Use ``std::vector<T`` here.
+Use ``a &copy; b &other`` here.
+Use ``<!-- text -->`` here.
+
+Use ``<code>value</code>`` here.
+Use ``<a href="x">text</a>`` here.
+Use ``<table><tr><td>value</td></tr></table>`` here.
+Use ``std::vector<T`` here.
+Use ``a &copy; b &other`` here.
+Use ``<!-- text -->`` here.
diff --git a/tests/corpus/compat_irregular_table.txt b/tests/corpus/compat_irregular_table.txt
@@ -0,0 +1,3 @@
+<table><tr><td colspan="2">&other <!-- keep --> <T</td></tr></table>
+================================================================================
+<table><tr><td colspan="2">&other <!-- keep --> <T</td></tr></table>
diff --git a/tests/corpus/compat_unknown_markup.txt b/tests/corpus/compat_unknown_markup.txt
@@ -0,0 +1,7 @@
+Text <Unknown>stuff</Unknown>.
+Writes XML comment as "<!-- text -->"
+Writes XML comment as "<!-- text -- >"
+================================================================================
+Text <Unknown>stuff</Unknown>.
+Writes XML comment as "<!-- text -->"
+Writes XML comment as "<!-- text -- >"
diff --git a/tests/corpus/enum_inline.txt b/tests/corpus/enum_inline.txt
@@ -0,0 +1,3 @@
+/**< input to user code from the simulator */
+================================================================================
+input to user code from the simulator
diff --git a/tests/corpus/html_whitespace.txt b/tests/corpus/html_whitespace.txt
@@ -0,0 +1,15 @@
+  /**
+   * Get the raw output ratio of the duty cycle signal.
+   *
+   * <p> 0 means always low, an output equal to
+   * GetOutputScaleFactor() means always high.
+   *
+   * @return output ratio in raw units
+   */
+================================================================================
+Get the raw output ratio of the duty cycle signal.
+
+0 means always low, an output equal to
+GetOutputScaleFactor() means always high.
+
+:returns: output ratio in raw units
diff --git a/tests/corpus/link_class_javadoc.txt b/tests/corpus/link_class_javadoc.txt
@@ -0,0 +1,11 @@
+  /**
+   * Use this method to define your button->command mappings. Buttons can be created by
+   * instantiating a {@link GenericHID} or one of its subclasses ({@link
+   * edu.wpi.first.wpilibj.Joystick} or {@link XboxController}), and then calling passing it to a
+   * {@link edu.wpi.first.wpilibj2.command.button.JoystickButton}.
+   */
+================================================================================
+Use this method to define your button->command mappings. Buttons can be created by
+instantiating a :class:`.GenericHID` or one of its subclasses ({@link
+edu.wpi.first.wpilibj.Joystick} or :class:`.XboxController`), and then calling passing it to a
+:class:`.JoystickButton`.
diff --git a/tests/corpus/multiple_single_line.txt b/tests/corpus/multiple_single_line.txt
@@ -0,0 +1,5 @@
+/// Some text goes here.
+/// More text.
+================================================================================
+Some text goes here.
+More text.
diff --git a/tests/corpus/note_multiline.txt b/tests/corpus/note_multiline.txt
@@ -0,0 +1,15 @@
+/**
+ * This is a paragraph.
+ *
+ * @note This is the start of a note that goes over multiple lines.
+ *     This should still be part of the note.
+ *
+ * @return entry
+ */
+================================================================================
+This is a paragraph.
+
+.. note:: This is the start of a note that goes over multiple lines.
+   This should still be part of the note.
+
+:returns: entry
diff --git a/tests/corpus/note_one_line.txt b/tests/corpus/note_one_line.txt
@@ -0,0 +1,9 @@
+/**
+ * NetworkTables struct-encoded value entry.
+ *
+ * @note Unlike NetworkTableEntry, the entry goes away when this is destroyed.
+ */
+================================================================================
+NetworkTables struct-encoded value entry.
+
+.. note:: Unlike NetworkTableEntry, the entry goes away when this is destroyed.
diff --git a/tests/corpus/param_no_indent.txt b/tests/corpus/param_no_indent.txt
@@ -0,0 +1,23 @@
+*
+* Sends an error to the driver station.
+*
+* @param isError   true for error, false for warning
+* @param errorCode the error code
+* @param isLVCode  true for a LV error code, false for a standard error code
+* @param details   the details of the error
+* @param location  the file location of the errror
+* @param callstack the callstack of the error
+* @param printMsg  true to print the error message to stdout as well as to the
+* DS
+*/
+================================================================================
+Sends an error to the driver station.
+
+:param isError:   true for error, false for warning
+:param errorCode: the error code
+:param isLVCode:  true for a LV error code, false for a standard error code
+:param details:   the details of the error
+:param location:  the file location of the errror
+:param callstack: the callstack of the error
+:param printMsg:  true to print the error message to stdout as well as to the
+                  DS
diff --git a/tests/corpus/simple_maths.txt b/tests/corpus/simple_maths.txt
@@ -0,0 +1,9 @@
+This is known to be broken. Output should include an escaped space before the role.
+
+x<sub>1</sub>
+x<sup>2</sup>
+================================================================================
+This is known to be broken. Output should include an escaped space before the role.
+
+x:sub:`1`
+x:sup:`2`
diff --git a/tests/corpus/snake_case_words.txt b/tests/corpus/snake_case_words.txt
@@ -0,0 +1,3 @@
+scale_value(joystick.getThrottle(), 1, -1, 0, 1)
+================================================================================
+scale_value(joystick.getThrottle(), 1, -1, 0, 1)
diff --git a/tests/corpus/tag_soup.txt b/tests/corpus/tag_soup.txt
@@ -0,0 +1,23 @@
+be <b>bold</b>
+be <strong>strong</strong>
+<i>italics</i>
+<em>emphasis</em>
+<sub>subscript</sub>
+<sup>superscript</sup>
+
+<strong>multiline
+  strong</strong>
+<i>multiline
+  italics</i>
+================================================================================
+be **bold**
+be **strong**
+*italics*
+*emphasis*
+:sub:`subscript`
+:sup:`superscript`
+
+:strong:`multiline
+strong`
+:emphasis:`multiline
+italics`
diff --git a/tests/corpus/trailing_underscores.txt b/tests/corpus/trailing_underscores.txt
@@ -0,0 +1,3 @@
+...target storage, FRC_ log files are deleted...
+================================================================================
+...target storage, FRC\_ log files are deleted...
diff --git a/tests/corpus/underscore_word.txt b/tests/corpus/underscore_word.txt
@@ -0,0 +1,3 @@
+a sentence where _ is a word
+================================================================================
+a sentence where _ is a word
diff --git a/tests/expected/compat_ampersands.txt b/tests/expected/compat_ampersands.txt
diff --git a/tests/expected/compat_cpp_references.txt b/tests/expected/compat_cpp_references.txt
diff --git a/tests/expected/compat_cpp_templates.txt b/tests/expected/compat_cpp_templates.txt
diff --git a/tests/expected/compat_incomplete_template.txt b/tests/expected/compat_incomplete_template.txt
diff --git a/tests/expected/compat_inline_literals.txt b/tests/expected/compat_inline_literals.txt
diff --git a/tests/expected/compat_irregular_table.txt b/tests/expected/compat_irregular_table.txt
diff --git a/tests/expected/compat_unknown_markup.txt b/tests/expected/compat_unknown_markup.txt
diff --git a/tests/expected/enum_inline.txt b/tests/expected/enum_inline.txt
diff --git a/tests/expected/html_whitespace.txt b/tests/expected/html_whitespace.txt
diff --git a/tests/expected/link_class_javadoc.txt b/tests/expected/link_class_javadoc.txt
diff --git a/tests/expected/multiple_single_line.txt b/tests/expected/multiple_single_line.txt
diff --git a/tests/expected/note_multiline.txt b/tests/expected/note_multiline.txt
diff --git a/tests/expected/note_one_line.txt b/tests/expected/note_one_line.txt
diff --git a/tests/expected/param_no_indent.txt b/tests/expected/param_no_indent.txt
diff --git a/tests/expected/simple_maths.txt b/tests/expected/simple_maths.txt
diff --git a/tests/expected/snake_case_words.txt b/tests/expected/snake_case_words.txt
diff --git a/tests/expected/tag_soup.txt b/tests/expected/tag_soup.txt
diff --git a/tests/expected/trailing_underscores.txt b/tests/expected/trailing_underscores.txt
diff --git a/tests/expected/underscore_word.txt b/tests/expected/underscore_word.txt
diff --git a/tests/input/compat_ampersands.txt b/tests/input/compat_ampersands.txt
diff --git a/tests/input/compat_cpp_references.txt b/tests/input/compat_cpp_references.txt
diff --git a/tests/input/compat_cpp_templates.txt b/tests/input/compat_cpp_templates.txt
diff --git a/tests/input/compat_incomplete_template.txt b/tests/input/compat_incomplete_template.txt
diff --git a/tests/input/compat_inline_literals.txt b/tests/input/compat_inline_literals.txt
diff --git a/tests/input/compat_irregular_table.txt b/tests/input/compat_irregular_table.txt
diff --git a/tests/input/compat_unknown_markup.txt b/tests/input/compat_unknown_markup.txt
diff --git a/tests/input/enum_inline.txt b/tests/input/enum_inline.txt
diff --git a/tests/input/html_whitespace.txt b/tests/input/html_whitespace.txt
diff --git a/tests/input/link_class_javadoc.txt b/tests/input/link_class_javadoc.txt
diff --git a/tests/input/multiple_single_line.txt b/tests/input/multiple_single_line.txt
diff --git a/tests/input/note_multiline.txt b/tests/input/note_multiline.txt
diff --git a/tests/input/note_one_line.txt b/tests/input/note_one_line.txt
diff --git a/tests/input/param_no_indent.txt b/tests/input/param_no_indent.txt
diff --git a/tests/input/simple_maths.txt b/tests/input/simple_maths.txt
diff --git a/tests/input/snake_case_words.txt b/tests/input/snake_case_words.txt
diff --git a/tests/input/tag_soup.txt b/tests/input/tag_soup.txt
diff --git a/tests/input/trailing_underscores.txt b/tests/input/trailing_underscores.txt
diff --git a/tests/input/underscore_word.txt b/tests/input/underscore_word.txt