mirror of
https://github.com/Ed94/Odin.git
synced 2026-08-05 15:18:49 +00:00
core: improve package doc comments for the documentation generator
This commit is contained in:
@@ -1,22 +1,22 @@
|
||||
/*
|
||||
Package list implements an intrusive doubly-linked list.
|
||||
|
||||
An intrusive container requires a `Node` to be embedded in your own structure, like this:
|
||||
|
||||
An intrusive container requires a `Node` to be embedded in your own structure, like this.
|
||||
Example:
|
||||
My_String :: struct {
|
||||
node: list.Node,
|
||||
value: string,
|
||||
}
|
||||
|
||||
Embedding the members of a `list.Node` in your structure with the `using` keyword is also allowed:
|
||||
|
||||
Embedding the members of a `list.Node` in your structure with the `using` keyword is also allowed.
|
||||
Example:
|
||||
My_String :: struct {
|
||||
using node: list.Node,
|
||||
value: string,
|
||||
}
|
||||
|
||||
Here is a full example:
|
||||
|
||||
Here is a full example.
|
||||
Example:
|
||||
package test
|
||||
|
||||
import "core:fmt"
|
||||
@@ -42,5 +42,8 @@ Here is a full example:
|
||||
value: string,
|
||||
}
|
||||
|
||||
Output:
|
||||
Hello
|
||||
World
|
||||
*/
|
||||
package container_intrusive_list
|
||||
|
||||
Reference in New Issue
Block a user