Skip to content

Docs: convert HTML tables and text lists to XML doc lists - #2182

Merged
RobertvanderHulst merged 1 commit into
mainfrom
docs/convert-tables-to-xml-lists
Nov 17, 2026
Merged

RobertvanderHulst merged 1 commit into
mainfrom
docs/convert-tables-to-xml-lists

Conversation

Copilot AI commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Normalizes list-like constructs in the documentation XML to the <list> form already used elsewhere in these files.

src/DocChinese and src/Docs

  • HTML <table>/<tr>/<th>/<td> constructs (8 tables) → <list type="table"> with <listheader> / <item> / <term> / <description>.

src/Docs only

  • Tab-separated text tables (e.g. ReportQueue.SetPapersize) → <list type="table">; tables with more than two columns use multiple <description> elements.
  • "Label:<tab>text" paragraphs → header-less <list type="table"> (trailing colon dropped from the term).
  • <param> pseudo-tables in VoFunctionDocs.xml (FError, Memory, RDD type list) → a table nested in the preceding <param>.
  • Numbered lists (1.<tab>text) → <list type="table"> with the number in the first column.
  • -<tab> bullets → <list type="bullet">.
  • Untyped <list> / type="Table" → type="table"; fixed a <listheaders> typo in VFPDocs.xml.
  • Lists that were wrapped in <pre> are unwrapped.

Text inside <code> blocks and existing lists is untouched. All XML files in both folders still parse.

Notes

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@RobertvanderHulst
RobertvanderHulst marked this pull request as ready for review November 17, 2026 17:18
Copilot AI balanced review requested due to automatic review settings November 17, 2026 17:18
@RobertvanderHulst
RobertvanderHulst merged commit 3b3de38 into main Nov 17, 2026
@RobertvanderHulst
RobertvanderHulst deleted the docs/convert-tables-to-xml-lists branch November 17, 2026 17:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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 thread src/Docs/Gui.xml
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants