Further overhaul of package line comments.

This commit is contained in:
Jeroen van Rijn
2025-10-09 23:05:29 +02:00
parent 2bc409eab5
commit 7a9ea3ee6d
147 changed files with 155 additions and 186 deletions
+1 -1
View File
@@ -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 -2
View File
@@ -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 -2
View File
@@ -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.
+3 -2
View File
@@ -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 -2
View File
@@ -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
View File
@@ -1,3 +1,4 @@
// Tokenizes regular expressions.
package regex_tokenizer
/*
+2 -3
View File
@@ -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.