aboutsummaryrefslogtreecommitdiff
path: root/core/container/bit_array
diff options
context:
space:
mode:
authorMaurizio M. Gavioli <mmg@vistamaresoft.com>2024-04-14 17:18:08 +0200
committerMaurizio M. Gavioli <mmg@vistamaresoft.com>2024-04-14 17:18:08 +0200
commita0cff82320840e4be6d40cee8a2432645773a53e (patch)
treedbb5b972d03b14f636ef0aa120da8075ee906fc0 /core/container/bit_array
parent21969fec612b78d34f14b60ad761a3c37860b36b (diff)
Fix the format of some `doc.odin` files of the `core` library which did not made into the documentation.
`c/frontend/tokenizer`: add proper "Example:" header to demo example code, removed empty lines. `container/bit_array`: moved comment before package; aligned narrative lines to left margin; converted case lines into bulleted lines ("- "); converted individual examples to single-tab-indented preformatted text. `dynlib`: removed "//+build ignore" line; added newline at EOF. `image/netpmb`: converted indented lines of "Reading", "Wrting" and "Some syntax..." into bulleted lists; "Formats" indented lines kept as they are as the preformatted text seems relevant to keep the alignments; doubly indented lines kept as single-indented to keep them different (as the format does not allow for two-level bulleted lists); removed empy lines. `os/os2`: WIP, not modified `sys/info`: removed "//+build ignore" line; converted tab-indented initial description into regular left-margin comment; moved uncommented sample code within the doc comment as an "Example:"; moved simple- and double-tabbed separate comments with sample Windows and macOS outputs within the doc comment as bulleted headlines with preformatted output listings; removed now empty comments and blank lines after the package line. `text/i18n`: removed "//+build ignore" line; moved the pacakge line at the end; de-indented the tab-indented introductory narrative; moved sample code comments into the doc comment as tab-indented code with a proper "Example:" heading; removed "```" MD attempts at code formatting. `text/table`: unindented the comment lines of a descriptive kind; headlines of major subdivisions are marked as bold; kept code samples as tab-indented preformatted text (as there are several of them, the standard "Example:" and "Output:" headings cannot be used) removing the "```" MD attempts at code formatting; removed in-between blank lines.
Diffstat (limited to 'core/container/bit_array')
-rw-r--r--core/container/bit_array/doc.odin75
1 files changed, 37 insertions, 38 deletions
diff --git a/core/container/bit_array/doc.odin b/core/container/bit_array/doc.odin
index 52e252d8a..371f63f0e 100644
--- a/core/container/bit_array/doc.odin
+++ b/core/container/bit_array/doc.odin
@@ -1,53 +1,52 @@
-package dynamic_bit_array
-
/*
- The Bit Array can be used in several ways:
+The Bit Array can be used in several ways:
- -- By default you don't need to instantiate a Bit Array:
+- By default you don't need to instantiate a Bit Array:
- package test
+ package test
- import "core:fmt"
- import "core:container/bit_array"
+ import "core:fmt"
+ import "core:container/bit_array"
- main :: proc() {
- using bit_array
+ main :: proc() {
+ using bit_array
- bits: Bit_Array
+ bits: Bit_Array
- // returns `true`
- fmt.println(set(&bits, 42))
+ // returns `true`
+ fmt.println(set(&bits, 42))
- // returns `false`, `false`, because this Bit Array wasn't created to allow negative indices.
- was_set, was_retrieved := get(&bits, -1)
- fmt.println(was_set, was_retrieved)
- destroy(&bits)
- }
+ // returns `false`, `false`, because this Bit Array wasn't created to allow negative indices.
+ was_set, was_retrieved := get(&bits, -1)
+ fmt.println(was_set, was_retrieved)
+ destroy(&bits)
+ }
- -- A Bit Array can optionally allow for negative indices, if the mininum value was given during creation:
+- A Bit Array can optionally allow for negative indices, if the minimum value was given during creation:
- package test
+ package test
- import "core:fmt"
- import "core:container/bit_array"
+ import "core:fmt"
+ import "core:container/bit_array"
- main :: proc() {
- Foo :: enum int {
- Negative_Test = -42,
- Bar = 420,
- Leaves = 69105,
- }
+ main :: proc() {
+ Foo :: enum int {
+ Negative_Test = -42,
+ Bar = 420,
+ Leaves = 69105,
+ }
- using bit_array
+ using bit_array
- bits := create(int(max(Foo)), int(min(Foo)))
- defer destroy(bits)
+ bits := create(int(max(Foo)), int(min(Foo)))
+ defer destroy(bits)
- fmt.printf("Set(Bar): %v\n", set(bits, Foo.Bar))
- fmt.printf("Get(Bar): %v, %v\n", get(bits, Foo.Bar))
- fmt.printf("Set(Negative_Test): %v\n", set(bits, Foo.Negative_Test))
- fmt.printf("Get(Leaves): %v, %v\n", get(bits, Foo.Leaves))
- fmt.printf("Get(Negative_Test): %v, %v\n", get(bits, Foo.Negative_Test))
- fmt.printf("Freed.\n")
- }
-*/ \ No newline at end of file
+ fmt.printf("Set(Bar): %v\n", set(bits, Foo.Bar))
+ fmt.printf("Get(Bar): %v, %v\n", get(bits, Foo.Bar))
+ fmt.printf("Set(Negative_Test): %v\n", set(bits, Foo.Negative_Test))
+ fmt.printf("Get(Leaves): %v, %v\n", get(bits, Foo.Leaves))
+ fmt.printf("Get(Negative_Test): %v, %v\n", get(bits, Foo.Negative_Test))
+ fmt.printf("Freed.\n")
+ }
+*/
+package dynamic_bit_array