Skip to content

[overview] Add example & expand docs for raddbg_type_view #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
blob1807 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[overview] Add example & expand docs for raddbg_type_view #313

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion content/docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4067,7 +4067,26 @@ And `#+private file` will be equivalent to automatically adding `@(private="file

#### `@(raddbg_type_view=<string?>)`

Adds custom a debug watch window rendering for the RAD Debugger. If no custom view rule as a string is set, then the Odin compiler will generate a specific view from the struct fields tags (reading the `fmt:"..."` style declarations).
Adds custom a debug watch window rendering for the RAD Debugger. If no custom view rule as a string is set, then the Odin compiler will generate a specific view from either `raddbg:"..."` struct fields tags, or by translating `fmt:"..."` tags.
```odin
@(raddbg_type_view="rows($, array(data, len), len)")
Arr_int :: struct {
data: [^]int,
len: int,
}

@(raddbg_type_view)
Arr_float :: struct {
data: [^]f64 `raddbg:"array(data, len)"`,
len: int,
}

@(raddbg_type_view)
Arr_rune :: struct {
data: [^]rune `fmt:",len"`,
len: int,
}
```

#### `@(require=<boolean?>)`

Expand Down