Repository navigation
Docs: add FoxPro command topics and fix existing command topics - #2177
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved documentation inaccuracies present unsupported commands, ignored options, and unenforced overwrite protection as working runtime behavior, potentially misleading users into compilation failures or data loss.
50 open issues
ASSERT displays a dialog for true expressions · New ASSERT displays a dialog even when the expression is true · New ASSERT displays a dialog even when the expression is true · New NOASSERT does not remove ASSERT statements from source · New Memo exports use the default Windows encoding when AS is omitted · New DATABASE/NAME uses an unimplemented DbAdd call · New COPY STRUCTURE does not support wildcard field selections · New DATABASE/NAME uses an unimplemented DbAdd call · New CREATE CONNECTION is unsupported · New CREATE CURSOR ignores NEXTVALUE and STEP · New CREATE FROM ARRAY does not use the array structure · New CREATE FROM ARRAY does not use the array structure · New CREATE TABLE opens the new file shared, not exclusively · New CREATE CURSOR opens the file shared, not exclusively · New Dbc.Create does not open or activate the new database · New CREATE DBF fails because the parser requires TABLE · New CREATE DBF fails because the parser requires TABLE · New CREATE TABLE does not apply the CODEPAGE option · New CREATE TABLE ignores the CODEPAGE option · New CHECK and DEFAULT clauses are parsed but not applied · New
And 30 more that still need to be addressed.
What changed in this PR
This documentation-only PR expands XSharp’s command reference with FoxPro topics and clarifies existing command documentation. It adds syntax, examples, compatibility notes, and navigation links without changing compiler or runtime code.
Changes:
- Adds FoxPro database, SQL, file-system, terminal, and SET command topics.
- Corrects existing descriptions, syntax, defaults, and cross-references.
- Registers new topics in the help table of contents.
| File | Description |
|---|---|
| docs/Help/Topics/SCAN-Command.xml | Explains SCAN expansion and adds related links. |
| docs/Help/Topics/command_WAIT_FoxPro.xml | Adds FoxPro WAIT syntax and examples. |
| docs/Help/Topics/command_WAIT_CLEAR.xml | Documents WAIT CLEAR and its support limitation. |
| docs/Help/Topics/command_USE.xml | Links to FoxPro USE documentation. |
| docs/Help/Topics/command_USE_FoxPro.xml | Adds FoxPro table-opening options. |
| docs/Help/Topics/command_UPDATE_SET.xml | Documents SQL-style UPDATE. |
| docs/Help/Topics/command_SORT_FoxPro.xml | Adds FoxPro sorting and field-selection syntax. |
| docs/Help/Topics/command_SET_VARCHARMAPPING.xml | Documents character-mapping setting. |
| docs/Help/Topics/command_SET_TIME.xml | Documents time-format selection. |
| docs/Help/Topics/Command_SET_TEXTMERGE.xml | Clarifies supported TEXTMERGE clauses. |
| docs/Help/Topics/command_SET_TEXTMERGE_DELIMITERS.xml | Adds delimiter syntax and example. |
| docs/Help/Topics/command_SET_STRICTREAD.xml | Documents strict and dirty index reads. |
| docs/Help/Topics/command_SET_SQLBUFFERING.xml | Adds SQLBUFFERING reference. |
| docs/Help/Topics/command_SET_SPACE.xml | Documents console-output spacing. |
| docs/Help/Topics/command_SET_SEPARATOR.xml | Documents thousands-separator setting. |
| docs/Help/Topics/command_SET_SECONDS.xml | Documents seconds-display setting. |
| docs/Help/Topics/command_SET_SAFETY.xml | Adds overwrite-safety setting reference. |
| docs/Help/Topics/command_SET_REFRESH.xml | Documents refresh interval and default. |
| docs/Help/Topics/command_SET_PRINTER.xml | Adds printer-output setting reference. |
| docs/Help/Topics/command_SET_POINT.xml | Documents decimal-separator setting. |
| docs/Help/Topics/command_SET_PATH_FoxPro.xml | Documents additive search paths. |
| docs/Help/Topics/command_SET_OPTIMIZE_FoxPro.xml | Adds FoxPro optimization-setting reference. |
| docs/Help/Topics/command_SET_NULL.xml | Documents NULL setting and support status. |
| docs/Help/Topics/command_SET_NEAR.xml | Explains failed-search positioning. |
| docs/Help/Topics/command_SET_MULTILOCKS.xml | Documents multiple-lock setting. |
| docs/Help/Topics/command_SET_MEMOWIDTH.xml | Adds memo-width setting reference. |
| docs/Help/Topics/command_SET_MEMOBLOCK.xml | Adds MEMOBLOCKSIZE syntax and default. |
| docs/Help/Topics/command_SET_MARGIN.xml | Adds print-margin setting reference. |
| docs/Help/Topics/command_SET_LOCK.xml | Documents automatic-locking setting. |
| docs/Help/Topics/command_SET_INDEX_FoxPro.xml | Adds FoxPro index-opening options. |
| docs/Help/Topics/command_SET_HOURS.xml | Documents 12- and 24-hour formats. |
| docs/Help/Topics/command_SET_HEADINGS.xml | Adds column-heading setting reference. |
| docs/Help/Topics/command_SET_FULLPATH.xml | Documents full-path setting. |
| docs/Help/Topics/command_SET_ESCAPE.xml | Adds Escape-key setting reference. |
| docs/Help/Topics/command_SET_DIRECTORY.xml | Documents default-directory command. |
| docs/Help/Topics/command_SET_DIGITS.xml | Clarifies omitted-value default. |
| docs/Help/Topics/command_SET_DEVICE.xml | Documents output-device selection. |
| docs/Help/Topics/command_SET_DELIMITERS.xml | Adds input-delimiter setting reference. |
| docs/Help/Topics/command_SET_DECIMALS.xml | Clarifies default and equivalent call. |
| docs/Help/Topics/command_SET_DATE.xml | Lists formats and links FoxPro variant. |
| docs/Help/Topics/command_SET_DATE_FoxPro.xml | Documents FoxPro date-format expressions. |
| docs/Help/Topics/command_SET_DATABASE.xml | Documents current-database selection. |
| docs/Help/Topics/command_SET_CURSOR.xml | Adds cursor-visibility setting reference. |
| docs/Help/Topics/command_SET_CONFIRM.xml | Adds input-confirmation setting reference. |
| docs/Help/Topics/command_SET_COMPATIBLE.xml | Documents compatibility-setting options. |
| docs/Help/Topics/command_SET_COLLATE.xml | Documents FoxPro collation setting. |
| docs/Help/Topics/command_SET_BLOCKSIZE.xml | Adds memo-block allocation reference. |
| docs/Help/Topics/command_SET_BELL.xml | Documents bell-setting options. |
| docs/Help/Topics/command_SET_AUTOINCERROR.xml | Adds auto-increment error-setting reference. |
| docs/Help/Topics/command_SET_ASSERTS.xml | Documents assertion-control setting. |
| docs/Help/Topics/command_SET_ANSI_FoxPro.xml | Distinguishes FoxPro SQL ANSI setting. |
| docs/Help/Topics/Command_SET_ALTERNATE.xml | Adds CLOSE ALTERNATE syntax. |
| docs/Help/Topics/command_SEEK_FoxPro.xml | Documents FoxPro indexed-search options. |
| docs/Help/Topics/command_SCAN.xml | Adds SCAN loop reference and example. |
| docs/Help/Topics/command_SAVE.xml | Corrects brackets and adds alternate syntax. |
| docs/Help/Topics/command_RMDIR.xml | Documents directory removal and RD alias. |
| docs/Help/Topics/command_REPLACE_FoxPro.xml | Adds FoxPro field-replacement reference. |
| docs/Help/Topics/command_RENAME_TABLE.xml | Documents logical table renaming. |
| docs/Help/Topics/command_REMOVE_TABLE.xml | Documents table removal and deletion options. |
| docs/Help/Topics/command_RECALL_FoxPro.xml | Adds FoxPro record-recall behavior. |
| docs/Help/Topics/command_OPEN_DATABASE.xml | Documents database-opening options. |
| docs/Help/Topics/command_MKDIR.xml | Documents directory creation and MD alias. |
| docs/Help/Topics/command_INSERT_INTO.xml | Adds SQL insert forms and examples. |
| docs/Help/Topics/command_INDEX_FoxPro.xml | Documents FoxPro index-creation options. |
| docs/Help/Topics/command_DELETE_FROM.xml | Adds SQL-style record-deletion reference. |
| docs/Help/Topics/command_DELETE_FoxPro.xml | Documents FoxPro deletion scope and tally. |
| docs/Help/Topics/command_DELETE_DATABASE.xml | Adds database-deletion command reference. |
| docs/Help/Topics/command_DELETE_CONNECTION.xml | Adds named-connection deletion reference. |
| docs/Help/Topics/command_CREATE_TABLE.xml | Documents SQL table-creation syntax. |
| docs/Help/Topics/command_CREATE_DATABASE.xml | Adds database-creation reference. |
| docs/Help/Topics/command_CREATE_CURSOR.xml | Documents temporary cursor creation. |
| docs/Help/Topics/command_CREATE_CONNECTION.xml | Adds named-connection creation reference. |
| docs/Help/Topics/command_COUNT.xml | Links to FoxPro COUNT documentation. |
| docs/Help/Topics/command_COUNT_FoxPro.xml | Documents optional TO clause and tally. |
| docs/Help/Topics/command_COPY_STRUCTURE_FoxPro.xml | Adds FoxPro structure-copy options. |
| docs/Help/Topics/command_COPY_STRUCTURE_EXTENDED_FoxPro.xml | Documents structure-description table creation. |
| docs/Help/Topics/command_COPY_MEMO.xml | Documents memo export options. |
| docs/Help/Topics/command_CLOSE.xml | Links to FoxPro closing commands. |
| docs/Help/Topics/command_CLOSE_TABLES.xml | Documents table-closing scope. |
| docs/Help/Topics/command_CLOSE_DATABASES.xml | Documents database-closing scope. |
| docs/Help/Topics/Command_CLEAR_SCREEN.xml | Corrects purpose and explains screen clearing. |
| docs/Help/Topics/command_CHDIR.xml | Documents directory changes and CD alias. |
| docs/Help/Topics/command_CAST_AS.xml | Documents FoxPro conversion expressions. |
| docs/Help/Topics/command_ASSERT.xml | Adds assertion syntax and dialog reference. |
| docs/Help/Topics/command_ALTER_TABLE.xml | Documents table-structure changes and limitations. |
| docs/Help/Topics/command_ADD_TABLE.xml | Documents adding tables to a database. |
| docs/Help/Maps/table_of_contents.xml | Adds categorized navigation entries for new topics. |
Review effort: Balanced
| <para styleclass="Heading1">Syntax</para> | ||
| <para styleclass="Code with box">ASSERT <lExpression> [MESSAGE <cMessageText>]</para> | ||
| <para styleclass="Heading1">Arguments</para> | ||
| <para styleclass="List"><lExpression><tab />The expression that is evaluated. Nothing happens when the expression returns TRUE.</para> |
| <para styleclass="Heading1">Syntax</para> | ||
| <para styleclass="Code with box">ASSERT <lExpression> [MESSAGE <cMessageText>]</para> | ||
| <para styleclass="Heading1">Arguments</para> | ||
| <para styleclass="List"><lExpression><tab />The expression that is evaluated. Nothing happens when the expression returns TRUE.</para> |
| <para styleclass="Heading1">Syntax</para> | ||
| <para styleclass="Code with box">ASSERT <lExpression> [MESSAGE <cMessageText>]</para> | ||
| <para styleclass="Heading1">Arguments</para> | ||
| <para styleclass="List"><lExpression><tab />The expression that is evaluated. Nothing happens when the expression returns TRUE.</para> |
| <para styleclass="List">MESSAGE <cMessageText><tab />The text that is displayed in the message box. When this clause is omitted, the text of the expression is displayed.</para> | ||
| <para styleclass="Heading1">Remarks</para> | ||
| <para styleclass="Normal">ASSERT only does something when <link displaytype="text" defaultstyle="true" type="topiclink" href="command_SET_ASSERTS">SET ASSERTS</link> is ON. When the assertion fails, a dialog is shown with the options Debug, Cancel, Ignore and Ignore All. Ignore All suppresses all following failed assertions.</para> | ||
| <para styleclass="Normal">When the compiler define NOASSERT is declared, the ASSERT commands are removed from the code by the preprocessor.</para> |
| <para styleclass="List"><MemoField><tab />The name of the memo field in the current work area.</para> | ||
| <para styleclass="List">TO <FileName><tab />The name of the file that receives the contents of the memo field.</para> | ||
| <para styleclass="List">ADDITIVE<tab />Appends the contents to the end of the file when it already exists. Without this clause an existing file is overwritten.</para> | ||
| <para styleclass="List">AS <nCodePage><tab />The code page of the text that is written to the file. When this clause is omitted, the text is written without conversion.</para> |
| <para styleclass="Heading1">Syntax</para> | ||
| <para styleclass="Code with box">SET SAFETY ON | OFF | &<cMacro></para> | ||
| <para styleclass="Heading1">Arguments</para> | ||
| <para styleclass="List">ON | OFF<tab />ON asks for confirmation before an existing file is overwritten. OFF overwrites the file without asking. The value may also be a macro (&) that evaluates to ON or OFF.</para> |
Comment on lines
+17
to
+21
| <para styleclass="Normal">Specifies whether the data that is returned by a remote SQL connection is buffered.</para> | ||
| <para styleclass="Heading1">Syntax</para> | ||
| <para styleclass="Code with box">SET SQLBUFFERING ON | OFF | &<cMacro></para> | ||
| <para styleclass="Heading1">Arguments</para> | ||
| <para styleclass="List">ON | OFF<tab />ON enables buffering, OFF disables it. The value may also be a macro (&) that evaluates to ON or OFF.</para> |
| <para styleclass="Heading1">Purpose</para> | ||
| <para styleclass="Normal">Specifies the delimiters that mark the expressions that are evaluated in text-merge output.</para> | ||
| <para styleclass="Heading1">Syntax</para> | ||
| <para styleclass="Code with box">SET TEXTMERGE DELIMITERS [TO [<cLeftDelimiter> [, <cRightDelimiter>]]]</para> |
| <para styleclass="Heading1">Purpose</para> | ||
| <para styleclass="Normal">Specifies the delimiters that mark the expressions that are evaluated in text-merge output.</para> | ||
| <para styleclass="Heading1">Syntax</para> | ||
| <para styleclass="Code with box">SET TEXTMERGE DELIMITERS [TO [<cLeftDelimiter> [, <cRightDelimiter>]]]</para> |
Comment on lines
+22
to
+25
| <para styleclass="List">TO <Variable><tab />The variable that receives the key that was pressed. When no key was pressed (NOWAIT, TIMEOUT, or when the program is not interactive) the variable receives an empty string.</para> | ||
| <para styleclass="List">WINDOW [AT <nRow>, <nColumn>]<tab />Displays the message in a window instead of on the screen. When the program is a GUI program, the message is displayed in a message box. The position is only used when it is supported by the window.</para> | ||
| <para styleclass="List">NOWAIT<tab />Displays the message and continues the program immediately, without waiting for a key.</para> | ||
| <para styleclass="List">NOCLEAR<tab />Leaves the message window open after the command has finished. Use <link displaytype="text" defaultstyle="true" type="topiclink" href="command_WAIT_CLEAR">WAIT CLEAR</link> to close it.</para> |
RobertvanderHulst
added a commit
that referenced
this pull request
Nov 17, 2026
… (#2179) Co-authored-by: RobertvanderHulst <14240939+RobertvanderHulst@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

No description provided.