Skip to content

Commit 1d1406f

Browse files
committed
Clean up of document headers
1 parent d412444 commit 1d1406f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ they should have the last argument be a callback function pointer.
236236
returncode_t libtock_[name]_[desc](<arguments>, libtock_[name]_callback_[desc] cb);
237237
```
238238

239-
### Example
239+
### Example:
240240

241241

242242
For example, a library called "sensor" with a sensor read operation should look
@@ -294,7 +294,7 @@ application upcall will run until the synchronous API has finished.
294294
| Source File Name | `libtock-sync/[category]/syscalls/[name]_syscalls.c` |
295295
| Header File Name | `libtock-sync/[category]/syscalls/[name]_syscalls.h` |
296296
297-
### Header File
297+
### Synchronous Syscall Header File
298298
299299
The `[name]_syscalls.h` must be wrapped in `extern "C" { ... }` if the header
300300
file is used in a C++ app.
@@ -354,7 +354,7 @@ returncode_t libtocksync_[name]_yield_wait_for(int* value) {
354354
}
355355
```
356356

357-
### Synchronous APIs
357+
### Synchronous Operations
358358

359359
The asynchronous operations should have matching synchronous versions using
360360
Yield-WaitFor internally.
@@ -365,7 +365,7 @@ Yield-WaitFor internally.
365365
| Source File Name | `libtock-sync/[category]/[name].c` |
366366
| Header File Name | `libtock-sync/[category]/[name].h` |
367367

368-
### Header Files
368+
### Synchronous Operation Header Files
369369

370370
The libtock-sync `[name].h` header file must look like:
371371

@@ -386,7 +386,7 @@ extern "C" {
386386
#endif
387387
```
388388

389-
### Synchronous APIs
389+
### Example:
390390

391391
For our sensor example:
392392

0 commit comments

Comments
 (0)