uli / basicengine-firmware

BASIC Engine Firmware
78 stars 16 forks source link

Incorrect tag in SCREEN command help #99

Closed CityAceE closed 1 month ago

CityAceE commented 2 months ago

I'm pretty sure '//XXX' onwards is an error, and it's a comment within a comment for the programmer, or it means the 'error' section of the command description.

{
  "command": "SCREEN",
  "tokens": [ "SCREEN" ],
  "section": "scr",
  "type": "bc",
  "brief": "Change the screen resolution.",
  "usage": "SCREEN mode",
  "args": {
    "mode": "screen mode [`1` to `10`]// XXX: No convenient way to auto-update the number of modes."
  },
  "modes": "The following modes are available:\n\table header\n| Mode | Resolution | Comment\n| 1 | 460x224 | Maximum usable resolution in NTSC mode.\n| 2 | 436x216 | Slightly smaller than mode 1; helpful if the display does not show the entirety of mode 1.\n| 3 | 320x216 |\n| 4 | 320x200 | Common resolution on many home computer systems.\n| 5 | 256x224 | Compatible with the SNES system.\n| 6 | 256x192 | Common resolution used by MSX, ZX Spectrum and others.\n| 7 | 160x200 | Common low-resolution mode on several home computer systems.\n| 8 | 352x240 | PC Engine-compatible overscan mode\n| 9 | 282x240 | PC Engine-compatible overscan mode\n| 10 | 508x240 | Maximum usable resolution in PAL mode. (Overscan on NTSC systems.)\n\endtable",
  "note": "* While the resolutions are the same for NTSC and PAL configurations, the actual sizes and aspect ratios vary depending on the TV system.\n* Resolutions have been chosen to match those used in other systems to facilitate porting of existing programs.\n* Apart from changing the mode, `SCREEN` clears the screen, resets the font and color space (palette) to their defaults, and disables sprites and tiled backgrounds.",
  "ref": [ "BG", "CLS", "FONT", "PALETTE", "SPRITE" ]
},
uli commented 1 month ago

Updated the mode list too, while I was at it.