17.5 Documentation

Parameters can have documentation strings that are shown in the command-line. These consist of one or more lines that begin with an exclamation mark, immediately following the parameter. Example:

  param ram_size : int
  ! RAM size in megabytes.
  ! Note that Windows 95 needs at least 2 MiB to run.

The script itself can also be described in the same way, by putting a documentation string first in a declaration block:

  decl {
    ! Atari 2600 Video Game Console System
    param cartridge : string = "COMBAT"
  }

Documentation strings are written in a subset of the Simics JDocu mark-up language, which is XML-based. Most plain text can be written directly, but the symbols '<' and '&' must be written '<' and '&', respectively. Use blank lines to break paragraphs.

The following typographic elements exist:

<tt>TEXT</tt>

set TEXT in a fixed-width font.

<em>TEXT</em>

set TEXT for emphasis (italic).

<param>TEXT</param>

set TEXT as the name of a parameter.