mirror of
https://github.com/Ed94/Odin.git
synced 2026-08-03 14:18:47 +00:00
Further overhaul of package line comments.
This commit is contained in:
@@ -1,4 +1,6 @@
|
||||
/*
|
||||
Text edit primitives to use in a text box.
|
||||
|
||||
Based off the articles by rxi:
|
||||
- [[ https://rxi.github.io/textbox_behaviour.html ]]
|
||||
- [[ https://rxi.github.io/a_simple_undo_system.html ]]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
|
||||
/*
|
||||
The `i18n` package is a flexible and easy to use way to localise applications.
|
||||
A flexible and easy way to add translations/internationalization (`i18n`) to applications.
|
||||
|
||||
It has two calls to get a translation: `get()` and `get_n()`, which the user can alias into something like `T` and `Tn`
|
||||
with statements like:
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
// A Lua-like string match algorithm.
|
||||
package text_match
|
||||
|
||||
import "base:runtime"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This package helps break dependency cycles.
|
||||
// This package helps break dependency cycles for the regular expression engine.
|
||||
package regex_common
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
/*
|
||||
package regex_compiler implements a bytecode compiler for the virtual machine
|
||||
included alongside it.
|
||||
A bytecode compiler for the virtual machine included alongside it.
|
||||
|
||||
Operands larger than u8 are written in system endian order.
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
/*
|
||||
package regex implements a complete suite for using Regular Expressions to
|
||||
match and capture text.
|
||||
A complete suite for using Regular Expressions to match and capture text.
|
||||
|
||||
Regular expressions are used to describe how a piece of text can match to
|
||||
another, using a pattern language.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
/*
|
||||
package regex_optimizer implements an optimizer which acts upon the AST of a
|
||||
parsed regular expression pattern, transforming it in-place without moving to a
|
||||
An optimizer for the regular expression AST.
|
||||
|
||||
Acts upon the AST of a parsed regular expression pattern, transforming it in-place without moving to a
|
||||
compilation step.
|
||||
|
||||
Where possible, it aims to reduce branching as much as possible in the
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
/*
|
||||
package regex_parser implements a Pratt parser, also known as a Top-Down
|
||||
Operator Precedence parser, for parsing tokenized regular expression patterns.
|
||||
A `Pratt` parser (a.k.a. Top-Down Operator Precedence parser) for parsing tokenized regular expression patterns.
|
||||
|
||||
References:
|
||||
- https://dl.acm.org/doi/10.1145/512927.512931
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
// Tokenizes regular expressions.
|
||||
package regex_tokenizer
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
package regex_vm implements a threaded virtual machine for interpreting
|
||||
regular expressions, based on the designs described by Russ Cox and attributed
|
||||
to both Ken Thompson and Rob Pike.
|
||||
A threaded virtual machine for interpreting regular expressions.
|
||||
Based on the designs described by Russ Cox and attributed to both Ken Thompson and Rob Pike.
|
||||
|
||||
The virtual machine executes all threads in lock step, i.e. the string pointer
|
||||
does not advance until all threads have finished processing the current rune.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// package text/scanner provides a scanner and tokenizer for UTF-8-encoded text.
|
||||
// A scanner and tokenizer for UTF-8-encoded text.
|
||||
// It takes a string providing the source, which then can be tokenized through
|
||||
// repeated calls to the scan procedure.
|
||||
// For compatibility with existing tooling and languages, the NUL character is not allowed.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
The package `table` implements plain-text/markdown/HTML/custom rendering of tables.
|
||||
Plain-text/markdown/HTML/custom rendering of tables.
|
||||
|
||||
**Custom rendering.**
|
||||
Example:
|
||||
|
||||
Reference in New Issue
Block a user