Skip to content

Commit fa806dd

Browse files
new docpages
1 parent 40e404c commit fa806dd

1,986 files changed

Lines changed: 68792 additions & 66529 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Doxyfile

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ PROJECT_BRIEF = "BASIC-Powered Operating System"
5454
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
5555
# to the output directory.
5656

57-
#PROJECT_LOGO = docpages/images/rr.png
57+
PROJECT_LOGO = docpages/images/rr.png
5858

5959
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
6060
# into which the generated documentation will be written. If a relative path is
@@ -276,7 +276,7 @@ OPTIMIZE_OUTPUT_VHDL = NO
276276
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
277277
# the files are not read by doxygen.
278278

279-
EXTENSION_MAPPING =
279+
EXTENSION_MAPPING =
280280

281281
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
282282
# according to the Markdown format, which allows for more readable
@@ -506,7 +506,7 @@ HIDE_SCOPE_NAMES = NO
506506
# the files that are included by a file in the documentation of that file.
507507
# The default value is: YES.
508508

509-
SHOW_INCLUDE_FILES = YES
509+
SHOW_INCLUDE_FILES = NO
510510

511511
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
512512
# grouped member an include statement to the documentation, telling the reader
@@ -749,7 +749,14 @@ WARN_LOGFILE =
749749
# spaces.
750750
# Note: If this tag is empty the current directory is searched.
751751

752-
INPUT = docpages include src
752+
INPUT = include src modules
753+
754+
# List Markdown explicitly, as files not dirs
755+
INPUT += docpages
756+
FILE_PATTERNS += *.md
757+
RECURSIVE = YES
758+
# Explicitly exclude the docpages folder so no directory page is made
759+
EXCLUDE += docpages
753760

754761
# This tag can be used to specify the character encoding of the source files
755762
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -2272,4 +2279,4 @@ DOT_GRAPH_MAX_NODES = 100
22722279

22732280

22742281
STRIP_FROM_PATH =
2275-
FULL_PATH_NAMES = YES
2282+
FULL_PATH_NAMES = NO

docpages/basic-language-reference/functions/integer/INPORT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ X = INPORT(port)
66
Reads a **byte** from an I/O `port` and returns it (0–255).
77

88

9-
> Only use on hardware that expects **8-bit** port reads at that address.
9+
@note Only use on hardware that expects **8-bit** port reads at that address.
1010

1111
---
1212

@@ -31,4 +31,4 @@ PRINT DATA
3131
- Continuous polling may stall the system; check status before reads if possible.
3232

3333
**See also:**
34-
[INPORTW](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTW) · [INPORTD](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTD) · [INPORTQ](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTQ) · [OUTPORT](https://github.com/brainboxdotcc/retro-rocket/wiki/OUTPORT)
34+
\ref INPORTW "INPORTW" · \ref INPORTD "INPORTD" · \ref INPORTQ "INPORTQ" · \ref OUTPORT "OUTPORT"

docpages/basic-language-reference/functions/integer/INPORTD.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ X = INPORTD(port)
66
Reads a **32-bit double-word** from `port` and returns it.
77

88

9-
> Only use on devices that specify **double-word** port access.
9+
@note Only use on devices that specify **double-word** port access.
1010

1111
---
1212

@@ -30,4 +30,4 @@ PRINT D
3030
- Most modern devices prefer MMIO; only use when the hardware requires 32-bit port access.
3131

3232
**See also:**
33-
[INPORT](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORT) · [INPORTW](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTW) · [INPORTQ](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTQ) · [OUTPORTD](https://github.com/brainboxdotcc/retro-rocket/wiki/OUTPORTD)
33+
\ref INPORT "INPORT" · \ref INPORTW "INPORTW" · \ref INPORTQ "INPORTQ" · \ref OUTPORTD "OUTPORTD"

docpages/basic-language-reference/functions/integer/INPORTQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ X = INPORTQ(port)
66
Reads a **64-bit quad-word** from `port` and returns it.
77

88

9-
> Very few devices support 64-bit port access; consult hardware documentation before use.
9+
@note Very few devices support 64-bit port access; consult hardware documentation before use.
1010

1111
---
1212

@@ -29,4 +29,4 @@ PRINT Q
2929
- Rare in practice; most hardware uses MMIO or smaller port widths.
3030

3131
**See also:**
32-
[INPORT](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORT) · [INPORTW](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTW) · [INPORTD](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTD) · [OUTPORTQ](https://github.com/brainboxdotcc/retro-rocket/wiki/OUTPORTQ)
32+
\ref INPORT "INPORT" · \ref INPORTW "INPORTW" · \ref INPORTD "INPORTD" · \ref OUTPORTQ "OUTPORTQ"

docpages/basic-language-reference/functions/integer/INPORTW.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ X = INPORTW(port)
66
Reads a **16-bit word** from `port` and returns it (0–65535).
77

88

9-
> Only use when the device expects **word** access.
9+
@note Only use when the device expects **word** access.
1010

1111
---
1212

@@ -30,4 +30,4 @@ PRINT W
3030
- Do not use unless the port is documented as word-accessible.
3131

3232
**See also:**
33-
[INPORT](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORT) · [INPORTD](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTD) · [INPORTQ](https://github.com/brainboxdotcc/retro-rocket/wiki/INPORTQ) · [OUTPORTW](https://github.com/brainboxdotcc/retro-rocket/wiki/OUTPORTW)
33+
\ref INPORT "INPORT" · \ref INPORTD "INPORTD" · \ref INPORTQ "INPORTQ" · \ref OUTPORTW "OUTPORTW"
Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11
\page INSTR INSTR Function
2+
3+
#### INSTR
4+
25
```basic
3-
INSTR(string-expression, string-expression)
6+
INSTR(haystack$, needle$)
47
```
5-
Returns `TRUE` if the first expression is contained in the second expression.
68

9+
Searches for the substring `needle$` inside the string `haystack$`.
10+
Returns the 1-based index of the first occurrence, or `0` if not found. The search is case-sensitive.
11+
12+
**Notes**
13+
14+
* The first parameter is the string to search in (the *haystack*).
15+
* The second parameter is the substring to search for (the *needle*).
16+
* If multiple matches exist, only the first occurrence is returned.
17+
* An empty `needle$` always returns `1`.
18+
19+
**Errors**
20+
21+
* None.
22+
23+
**Examples**
24+
25+
@code
26+
PRINT INSTR("HELLO WORLD", "WORLD") ' Prints: 7
27+
PRINT INSTR("HELLO WORLD", "world") ' Prints: 0 (case-sensitive)
28+
PRINT INSTR("ABCDE", "A") ' Prints: 1
29+
PRINT INSTR("ABCDE", "") ' Prints: 1
30+
@endcode
31+
32+
**See also**
33+
34+
\ref LEFT "LEFT$" · \ref RIGHT "RIGHT$" · \ref MID "MID$" · \ref LEN "LEN$"

docpages/basic-language-reference/functions/integer/PEEK.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ X = PEEK(address)
66
Reads a **single byte** from the specified memory `address` and returns it as an integer (0–255).
77

88

9-
> `PEEK` reads only from **mapped** memory. If `address` (or any byte it touches) is not permitted by the system memory map, an error is raised: `Bad Address at <address>`.
9+
@note `PEEK` reads only from **mapped** memory. If `address` (or any byte it touches) is not permitted by the system memory map, an error is raised: `Bad Address at <address>`.
1010

1111
---
1212

@@ -40,4 +40,4 @@ IF (STATUS AND 1) <> 0 THEN PRINT "Ready"
4040
- Accessing device MMIO may have **side effects**.
4141

4242
**See also:**
43-
[PEEKW](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEKW) · [PEEKD](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEKD) · [PEEKQ](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEKQ) · [POKE](https://github.com/brainboxdotcc/retro-rocket/wiki/POKE)
43+
\ref PEEKW "PEEKW" · \ref PEEKD "PEEKD" · \ref PEEKQ "PEEKQ" · \ref POKE "POKE"

docpages/basic-language-reference/functions/integer/PEEKD.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ X = PEEKD(address)
66
Reads a **32-bit double-word** from `address` and returns it as an integer (0–4294967295).
77

88

9-
> The entire 4-byte span must be valid; otherwise `Bad Address at <address>` is raised.
9+
@note The entire 4-byte span must be valid; otherwise `Bad Address at <address>` is raised.
1010

1111
---
1212

@@ -30,4 +30,4 @@ PRINT D
3030
- 32-bit is common for MMIO registers.
3131

3232
**See also:**
33-
[PEEK](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEK) · [PEEKW](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEKW) · [PEEKQ](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEKQ) · [POKED](https://github.com/brainboxdotcc/retro-rocket/wiki/POKED)
33+
\ref PEEK "PEEK" · \ref PEEKW "PEEKW" · \ref PEEKQ "PEEKQ" · \ref POKED "POKED"

docpages/basic-language-reference/functions/integer/PEEKQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ X = PEEKQ(address)
66
Reads a **64-bit quad-word** from `address` and returns it as an integer.
77

88

9-
> The full 8-byte span must be valid; otherwise `Bad Address at <address>` is raised.
9+
@note The full 8-byte span must be valid; otherwise `Bad Address at <address>` is raised.
1010

1111
---
1212

@@ -30,4 +30,4 @@ PRINT Q
3030
- Use for 64-bit fields or counters; don’t assume atomicity for unaligned addresses.
3131

3232
**See also:**
33-
[PEEK](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEK) · [PEEKD](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEKD) · [POKEQ](https://github.com/brainboxdotcc/retro-rocket/wiki/POKEQ)
33+
\ref PEEK "PEEK" · \ref PEEKD "PEEKD" · \ref POKEQ "POKEQ"

docpages/basic-language-reference/functions/integer/PEEKW.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ X = PEEKW(address)
66
Reads a **16-bit word** from `address` and returns it as an integer (0–65535).
77

88

9-
> The full 2-byte span must be valid and mapped, or `Bad Address at <address>` is raised.
9+
@note The full 2-byte span must be valid and mapped, or `Bad Address at <address>` is raised.
1010

1111
---
1212

@@ -30,4 +30,4 @@ PRINT W
3030
- Match the width to the device register size for MMIO.
3131

3232
**See also:**
33-
[PEEK](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEK) · [PEEKD](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEKD) · [PEEKQ](https://github.com/brainboxdotcc/retro-rocket/wiki/PEEKQ) · [POKEW](https://github.com/brainboxdotcc/retro-rocket/wiki/POKEW)
33+
\ref PEEK "PEEK" · \ref PEEKD "PEEKD" · \ref PEEKQ "PEEKQ" · \ref POKEW "POKEW"

0 commit comments

Comments
 (0)