Skip to content

Commit 5146aa1

Browse files
urishurish
committed
fix(chips-api): typos
`void \*` -> `void *`
1 parent 5d9845a commit 5146aa1

File tree

13 files changed

+45
-45
lines changed

13 files changed

+45
-45
lines changed

‎docs/chips-api/i2c.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Initializes an I2C device. The `config` argument defines the pins, address, and
2020
| `read` | callback | Called when the microcontroller wants to read a byte of data from your chip |
2121
| `write` | callback | Called when the microcontroller writes a byte to your chip |
2222
| `disconnect` | callback | Called when the microcontroller disconnects from your chip |
23-
| `user_data` | `void \*` | Data that will be passed in the first argument of the callbacks |
23+
| `user_data` | `void *` | Data that will be passed in the first argument of the callbacks |
2424

2525
All the callbacks (`connect`, `read`, `write`, `disconnect`) are optional. They all use the `user_data` pointer as their first argument.
2626

‎docs/chips-api/spi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Initializes an SPI device interface. The `config` argument defines the pins, mod
1818
| `miso` | `pin_t` | The MISO data pin (or `NO_PIN` to disable MISO) |
1919
| `mode` | `uint32_t` | SPI mode: `0`, `1`, `2`, or `3` (default: `0`) |
2020
| `done` | `callback` | Called when an SPI transaction finishes (see below) |
21-
| `user_data` | `void \*` | Data that will be passed in the first argument of the `done` callback |
21+
| `user_data` | `void *` | Data that will be passed in the first argument of the `done` callback |
2222

2323
The API does not support a CS/SS pin: it is up to the user to select/deselect the SPI interface by calling `spi_start()` and `spi_stop()`.
2424

‎docs/chips-api/time.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Initializes a new timer. Returns the identifier of the timer. Call `timer_start(
1919

2020
The `timer_config_t` struct contains the following fields:
2121

22-
| Field | Type | Description |
23-
| ----------- | --------- | -------------------------------------------------------------- |
24-
| `callback` | callback | Called when the timer fires |
25-
| `user_data` | `void \*` | Data that will be passed in the first argument to the callback |
22+
| Field | Type | Description |
23+
| ----------- | -------- | -------------------------------------------------------------- |
24+
| `callback` | callback | Called when the timer fires |
25+
| `user_data` | `void *` | Data that will be passed in the first argument to the callback |
2626

2727
The signature for the callback function is as follows:
2828

‎docs/chips-api/uart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Initializes UART device. The `config` argument defines the pins, configuration,
1818
| `baud_rate` | `uint32_t` | The baud rate (e.g. 115200) |
1919
| `rx_data` | callback | Called for each byte received on the RX pin |
2020
| `write_done` | callback | Called when data transmission on the TX pin has finished |
21-
| `user_data` | `void \*` | Data that will be passed in the first argument of the callbacks |
21+
| `user_data` | `void *` | Data that will be passed in the first argument of the callbacks |
2222

2323
Both of the callbacks (`rx_data`, `write_done`) are optional. They all use the `user_data` pointer as their first argument.
2424

‎i18n/de-DE/docusaurus-plugin-content-docs/current/chips-api/i2c.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ Um ein I2C-Gerät zu erstellen rufe als erstes `i2c_init` und übergib die Struc
1111

1212
Initialisiert ein I2C-Gerät. Das Argument `config` definiert die Pins, Adressen, und Callbacks für das I2C-Gerät. Es enthält folgende Felder:
1313

14-
| Feld | Typ | Beschreibung |
15-
| ------------ | ---------- | -------------------------------------------------------------------------------------------------- |
14+
| Feld | Typ | Beschreibung |
15+
| ------------ | ---------- | ------------------------------------------------------------------------------------------------------- |
1616
| `address` | `uint32_t` | Warten auf Anfragen, die der angegebenen I2C-Adresse entsprechen. (7-bit). `0` bedeutet "alle Anfragen" |
17-
| `sda` | `pin_t` | Der SDA-Pin |
18-
| `scl` | `pin_t` | Der SCL-Pin |
19-
| `connect` | callback | Wird aufgerufen, wenn der Chip auf dem I2C-Bus angesteuert wird |
20-
| `read` | callback | Wird aufgerufen, wenn der Microcontroller einen Byte vom Chip lesen will |
21-
| `write` | callback | Wird aufgerufen, wenn der Microcontroller einen Byte auf den Chip schreibt |
22-
| `disconnect` | callback | Wird aufgerufen, wenn der Microcontroller die Verbindung zum Chip trennt |
23-
| `user_data` | `void \*` | Data that will be passed in the first argument of the callbacks |
17+
| `sda` | `pin_t` | Der SDA-Pin |
18+
| `scl` | `pin_t` | Der SCL-Pin |
19+
| `connect` | callback | Wird aufgerufen, wenn der Chip auf dem I2C-Bus angesteuert wird |
20+
| `read` | callback | Wird aufgerufen, wenn der Microcontroller einen Byte vom Chip lesen will |
21+
| `write` | callback | Wird aufgerufen, wenn der Microcontroller einen Byte auf den Chip schreibt |
22+
| `disconnect` | callback | Wird aufgerufen, wenn der Microcontroller die Verbindung zum Chip trennt |
23+
| `user_data` | `void *` | Data that will be passed in the first argument of the callbacks |
2424

2525
Die Callbacks (`connect`, `read`, `write`, `disconnect`) sind optional. Alle Callbacks nutzen den `user_data` Pointer als erstes Argument.
2626

‎i18n/de-DE/docusaurus-plugin-content-docs/current/chips-api/spi.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ Um ein SPI-Gerät zu erstellen, rufe zuerst `spi_init` auf und übergib die Stru
1111

1212
Initialisiert eine SPI-Geräteschnittstelle. Das Argument `config` definiert Pins, Modi und Callbacks für das SPI-Gerät. Es enthält folgende Felder:
1313

14-
| Field | Type | Description |
15-
| ----------- | ---------- | --------------------------------------------------------------------- |
16-
| `sck` | `pin_t` | Der Clock Pin |
17-
| `mosi` | `pin_t` | Der MOSI data Pin (oder `NO_PIN` um MOSI zu deaktivieren) |
18-
| `miso` | `pin_t` | Der MISO data Pin (oder `NO_PIN` um MISO zu deaktivieren) |
19-
| `mode` | `uint32_t` | SPI Modus: `0`, `1`, `2`, oder `3` (Standard: `0`) |
20-
| `done` | `callback` | Wird aufgerufen, wenn die SPI Übertragung fertig ist (siehe unten) |
21-
| `user_data` | `void \*` | Daten werden an das erste Argument vom `done` Callback übergeben |
14+
| Field | Type | Description |
15+
| ----------- | ---------- | ------------------------------------------------------------------ |
16+
| `sck` | `pin_t` | Der Clock Pin |
17+
| `mosi` | `pin_t` | Der MOSI data Pin (oder `NO_PIN` um MOSI zu deaktivieren) |
18+
| `miso` | `pin_t` | Der MISO data Pin (oder `NO_PIN` um MISO zu deaktivieren) |
19+
| `mode` | `uint32_t` | SPI Modus: `0`, `1`, `2`, oder `3` (Standard: `0`) |
20+
| `done` | `callback` | Wird aufgerufen, wenn die SPI Übertragung fertig ist (siehe unten) |
21+
| `user_data` | `void *` | Daten werden an das erste Argument vom `done` Callback übergeben |
2222

2323
Die API unterstützt keine CS/SS Pins: die SPI-Schnittstelle durch das Aufrufen von `spi_start()` und `spi_stop()` zu aktivieren/deaktivieren ist dem Nutzer selbst überlassen.
2424

‎i18n/de-DE/docusaurus-plugin-content-docs/current/chips-api/time.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_label: Time API
1010
Gibt die Zeit vom aktuellen Simulator (virtuell) in Nanosekunden zurück.
1111

1212
:::tip
13-
Du kannst die aktuelle Zeit in Millisekunden durch das Aufrufen von `get_sim_nanos() / 1000000` bekommen.
13+
Du kannst die aktuelle Zeit in Millisekunden durch das Aufrufen von `get_sim_nanos() / 1000000` bekommen.
1414
:::
1515

1616
### timer_t timer_init(timer_config_t \*config)
@@ -19,10 +19,10 @@ Initialisiert einen neuen Timer. Gibt die ID vom Timer zurück. Rufe `timer_star
1919

2020
Die Struct `timer_config_t` enthält folgende Felder:
2121

22-
| Feld | Typ | Beschreibung |
23-
| ----------- | --------- | -------------------------------------------------------------- |
24-
| `callback` | callback | Wird aufgerufen, wenn der Timer ausgelöst wird |
25-
| `user_data` | `void \*` | Daten, die in das erste Argument vom Callback übergeben werden |
22+
| Feld | Typ | Beschreibung |
23+
| ----------- | -------- | -------------------------------------------------------------- |
24+
| `callback` | callback | Wird aufgerufen, wenn der Timer ausgelöst wird |
25+
| `user_data` | `void *` | Daten, die in das erste Argument vom Callback übergeben werden |
2626

2727
Die Signatur der Callbackfunktion sieht folgendermaßen aus:
2828

‎i18n/de-DE/docusaurus-plugin-content-docs/current/chips-api/uart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Initialisiert ein UART-Gerät. Das Argument `config` definiert die Pins, Konfigu
1818
| `baud_rate` | `uint32_t` | Die Baudrate (z.B. 115200) |
1919
| `rx_data` | callback | Wird für jeden empfangenen Byte am RX-Pin aufgerufen |
2020
| `write_done` | callback | Wird aufgerufen, wenn die Übertragung am TX-Pin fertig ist |
21-
| `user_data` | `void \*` | Daten, die in das erste Argument der Callbacks übergeben werden |
21+
| `user_data` | `void *` | Daten, die in das erste Argument der Callbacks übergeben werden |
2222

2323
Die beiden Callbacks (`rx_data` und `write_done`) sind optional. Sie nutzen einen Pointer auf `user_data` als erstes Argument.
2424

‎i18n/pt-BR/docusaurus-plugin-content-docs/current/chips-api/gpio.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Escuta as mudanças no valor digital do pino fornecido. A estrutura de configura
5555
| ------------ | ---------- | -------------------------------------------------------------------------- |
5656
| `edge` | `uint32_t` | Quais mudanças de valor de pinos escutamos (`RISING`, `FALLING` ou `BOTH`) |
5757
| `pin_change` | callback | Chamado quando o valor do pino muda (Veja abaixo) |
58-
| `user_data` | `void \*` | Dados que serão passados no primeiro argumento para `pin_change` |
58+
| `user_data` | `void *` | Dados que serão passados no primeiro argumento para `pin_change` |
5959

6060
Os valores válidos para borda são:
6161

‎i18n/pt-BR/docusaurus-plugin-content-docs/current/chips-api/i2c.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Inicializa um dispositivo I2C. O argumento `config` define os pinos, endereço e
2020
| `read` | callback | Chamado quando o microcontrolador quer ler um byte de dados do seu chip |
2121
| `write` | callback | Chamado quando o microcontrolador escreve um byte no seu chip |
2222
| `disconnect` | callback | Chamado quando o microcontrolador se desconecta do seu chip |
23-
| `user_data` | `void \*` | Dados que serão passados no primeiro argumento dos callbacks |
23+
| `user_data` | `void *` | Dados que serão passados no primeiro argumento dos callbacks |
2424

2525
Todos os callbacks (`connect`, `read`, `write`, `disconnect`) são opcionais. Todos eles usam o ponteiro `user_data` como seu primeiro argumento.
2626

0 commit comments

Comments
 (0)