Repository navigation
Docs: convert HTML tables and text lists to XML doc lists - #2182
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot CLI created this pull request from a session on behalf of
RobertvanderHulst
November 17, 2026 17:15
RobertvanderHulst
marked this pull request as ready for review
November 17, 2026 17:18
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documentation conversion loses the pointer return-value table entry, splits Dispatch() step 3 mid-sentence, and places the final octave pair in the wrong columns.
3 open issues
What changed in this PR
Normalizes XSharp’s English and Chinese API documentation to use XML documentation lists instead of HTML tables and plain-text lists. This changes documentation formatting, not runtime behavior.
Changes:
- Converts HTML and tab-separated tables to structured XML lists.
- Converts numbered steps, bullets, and parameter pseudo-tables into list elements.
- Standardizes table-list attributes, fixes a header-tag typo, and removes surrounding
<pre>wrappers.
| File | Description |
|---|---|
src/Docs/XPPComments.Xml |
Marks nested class-information lists as tables. |
src/Docs/VoFunctionDocs.xml |
Structures runtime reference tables, notes, and lists. |
src/Docs/VfpRuntimeDocs.xml |
Converts the ALEN parameter table. |
src/Docs/VFPDocs.xml |
Corrects list-header markup and table typing. |
src/Docs/Sql.Xml |
Structures SQL constants and notes as tables. |
src/Docs/Report.Xml |
Converts report options and paper sizes to tables. |
src/Docs/Rdd.xml |
Structures database scope rules and seek notes. |
src/Docs/Gui.xml |
Converts GUI instructions and normalizes tables. |
src/Docs/CoreComments.Xml |
Converts string-comparison return values to a table list. |
src/DocChinese/VfpRuntimeDocs.xml |
Converts the Chinese ALEN parameter table. |
src/DocChinese/Report.Xml |
Converts the Chinese paper-size table. |
src/DocChinese/Gui.xml |
Converts list-box and help-keyword HTML tables. |
Review effort: Balanced
Comment on lines
+25473
to
25476
| <description>In general, the implementation of this event handler should call Default(). This keeps the same behavior as the base class, but it also</description> | ||
| </item> | ||
| </list> | ||
| allows other classes to provide useful event handlers for your new type of event, allowing you to provide a framework for other classes to use. |
Comment on lines
+25825
to
+25828
| <term>C</term> | ||
| <description>523.30</description> | ||
| <description></description> | ||
| <description></description> |
Comment on lines
+26688
to
+26693
| </list> | ||
| <list type="bullet"> | ||
| <item> | ||
| PTR | ||
| </item> | ||
| </list> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Normalizes list-like constructs in the documentation XML to the
<list>form already used elsewhere in these files.src/DocChineseandsrc/Docs<table>/<tr>/<th>/<td>constructs (8 tables) →<list type="table">with<listheader>/<item>/<term>/<description>.src/DocsonlyReportQueue.SetPapersize) →<list type="table">; tables with more than two columns use multiple<description>elements.<list type="table">(trailing colon dropped from the term).<param>pseudo-tables inVoFunctionDocs.xml(FError,Memory, RDD type list) → a table nested in the preceding<param>.1.<tab>text) →<list type="table">with the number in the first column.-<tab>bullets →<list type="bullet">.<list>/type="Table"→type="table"; fixed a<listheaders>typo inVFPDocs.xml.<pre>are unwrapped.Text inside
<code>blocks and existing lists is untouched. All XML files in both folders still parse.Notes
main(the checked-out base). The local clone is shallow and has no common history withdev, so a PR againstdevisn't possible from this branch;devhas since changed these files too (e.g. [Doc] Complete Chinese translation of runtime docs and convert list-like text to tables #2181), so a rebase/merge may be needed.src/DocChinesewas only touched for the HTML table conversion; its bare<list>elements were left as is.