mirror of
https://github.com/KarolS/millfork.git
synced 2025-01-12 03:30:09 +00:00
Documentation fixes
This commit is contained in:
parent
77b3628dde
commit
b4b2e9b041
@ -41,9 +41,11 @@
|
||||
|
||||
* [`string` module](stdlib/string.md)
|
||||
|
||||
* [`stdio` module](stdlib/stdio.md)
|
||||
|
||||
* [Modules for reading input devices](stdlib/input.md)
|
||||
|
||||
* [Other cross-platform modules (`err`, `stdio`, `random`)](stdlib/other.md)
|
||||
* [Other cross-platform modules (`err`, `random`)](stdlib/other.md)
|
||||
|
||||
* [Definitions available on only some platforms](stdlib/frequent.md)
|
||||
|
||||
|
@ -41,9 +41,11 @@
|
||||
|
||||
* [`string` module](stdlib/string.md)
|
||||
|
||||
* [`stdio` module](stdlib/stdio.md)
|
||||
|
||||
* [Modules for reading input devices](stdlib/input.md)
|
||||
|
||||
* [Other cross-platform modules (`err`, `stdio`, `random`)](stdlib/other.md)
|
||||
* [Other cross-platform modules (`err`, `random`)](stdlib/other.md)
|
||||
|
||||
* [Definitions available on only some platforms](stdlib/frequent.md)
|
||||
|
||||
|
@ -20,15 +20,15 @@ TODO
|
||||
|
||||
TODO
|
||||
|
||||
## c1531_mouse
|
||||
## c1531
|
||||
|
||||
The `c1531_mouse` module implements a Commodore 1531 proportional mouse driver compatible with the `mouse` module.
|
||||
The `c1531` module implements a Commodore 1531 proportional mouse driver compatible with the `mouse` module.
|
||||
|
||||
#### `void c1531_mouse()`
|
||||
|
||||
Updates the state of the mouse.
|
||||
|
||||
## c1531_mouse_default
|
||||
## c1531_default
|
||||
|
||||
Defines the `c1531` module as the default module for reading mouse input.
|
||||
|
||||
|
@ -21,6 +21,7 @@ Vertical joystick movement. 1 if right, -1 if left, 0 if neither.
|
||||
|
||||
Resets the state variables.
|
||||
For platforms with more than one button, this resets only the main button state.
|
||||
On those platforms use the platform-specific functions instead.
|
||||
|
||||
## null_joy_default
|
||||
|
||||
@ -61,6 +62,6 @@ or `word` if the screen is more that 256 pixels wide.
|
||||
|
||||
## null_mouse_default
|
||||
|
||||
This module set the default joystick to no joystick.
|
||||
This module set the default mouse to no mouse.
|
||||
|
||||
#### `void read_mouse()`
|
||||
|
@ -1,24 +1,5 @@
|
||||
[< back to index](../index.md)
|
||||
|
||||
## stdio
|
||||
|
||||
The `stdio` module automatically imports the `string` and `err` modules.
|
||||
It requires an implementation of `void putchar(byte a)` and therefore works only on targets with console output.
|
||||
|
||||
#### `void putstr(pointer str, byte len)`
|
||||
|
||||
Prints a string of length `len` located at address `str`.
|
||||
|
||||
#### `void putstrz(pointer str)`
|
||||
|
||||
Prints a null-terminated string located at address `str`.
|
||||
If the string is longer than 255 bytes, then the behaviour is undefined (might even crash).
|
||||
|
||||
#### `void ensure_mixedcase()`
|
||||
|
||||
On targets that have separate all-caps and mixed-case modes (like most Commodore machines), switches to the mixed-case mode.
|
||||
|
||||
|
||||
## err
|
||||
|
||||
#### `enum error_number`
|
||||
|
24
docs/stdlib/stdio.md
Normal file
24
docs/stdlib/stdio.md
Normal file
@ -0,0 +1,24 @@
|
||||
[< back to index](../index.md)
|
||||
|
||||
## stdio
|
||||
|
||||
The `stdio` module automatically imports the `string` and `err` modules.
|
||||
It requires an implementation of `void putchar(byte a)` and therefore works only on targets with console output.
|
||||
|
||||
#### `void putstr(pointer str, byte len)`
|
||||
|
||||
Prints a string of length `len` located at address `str`.
|
||||
|
||||
#### `void putstrz(pointer str)`
|
||||
|
||||
Prints a null-terminated string located at address `str`.
|
||||
If the string is longer than 255 bytes, then the behaviour is undefined (might even crash).
|
||||
|
||||
#### `void putword(word w)`
|
||||
|
||||
Prints the decimal representation of the 16-bit unsigned integer `w`.
|
||||
|
||||
#### `void ensure_mixedcase()`
|
||||
|
||||
On targets that have separate all-caps and mixed-case modes (like most Commodore machines), switches to the mixed-case mode.
|
||||
|
@ -11,7 +11,7 @@ If the string is longer than 255 bytes, then the behaviour is undefined (might e
|
||||
|
||||
#### `sbyte strzcmp(pointer str1, pointer str2)`
|
||||
|
||||
Compares two strings. Returns 0 if equal, non-0 if not equal.
|
||||
Compares two null-terminated strings. Returns 0 if equal, non-0 if not equal.
|
||||
If any of the strings is longer than 255 bytes, then the behaviour is undefined (might even crash).
|
||||
|
||||
#### `void strzcopy(pointer dest, pointer src)`
|
||||
@ -27,4 +27,4 @@ Sets `errno`.
|
||||
#### `void strzappend(pointer buffer, pointer str)`
|
||||
#### `void strzappendchar(pointer buffer, byte char)`
|
||||
|
||||
Modifies the given null-terminated buffer by appending a null-terminated string or s single character respectively.
|
||||
Modifies the given null-terminated buffer by appending a null-terminated string or a single character respectively.
|
||||
|
Loading…
x
Reference in New Issue
Block a user