From 8a35acd50609e3ac1463bffebc79955b7ea619b8 Mon Sep 17 00:00:00 2001 From: Jeroen van Rijn Date: Thu, 9 Oct 2025 20:11:06 +0200 Subject: [PATCH] More package lines. --- core/hash/doc.odin | 2 ++ core/image/doc.odin | 2 ++ core/mem/doc.odin | 3 +-- core/mem/tlsf/tlsf.odin | 6 +++--- core/mem/virtual/doc.odin | 2 +- core/net/doc.odin | 31 ++++++++++++++-------------- core/odin/ast/ast.odin | 1 + core/odin/doc-format/doc_format.odin | 1 + core/odin/doc.odin | 2 ++ core/odin/parser/parser.odin | 1 + core/odin/tokenizer/tokenizer.odin | 1 + core/os/os.odin | 1 + 12 files changed, 31 insertions(+), 22 deletions(-) create mode 100644 core/hash/doc.odin create mode 100644 core/image/doc.odin create mode 100644 core/odin/doc.odin diff --git a/core/hash/doc.odin b/core/hash/doc.odin new file mode 100644 index 000000000..5fdc79cb7 --- /dev/null +++ b/core/hash/doc.odin @@ -0,0 +1,2 @@ +// package hash implements crc32, crc64, adler32, djb, fnv, jenkins, murmur and other hashes. +package hash \ No newline at end of file diff --git a/core/image/doc.odin b/core/image/doc.odin new file mode 100644 index 000000000..cb6bc4d96 --- /dev/null +++ b/core/image/doc.odin @@ -0,0 +1,2 @@ +// package image implements a general 2D image library to be used with other image related packages. +package image \ No newline at end of file diff --git a/core/mem/doc.odin b/core/mem/doc.odin index 580b08c96..8b4a77b6c 100644 --- a/core/mem/doc.odin +++ b/core/mem/doc.odin @@ -1,6 +1,5 @@ /* -The `mem` package implements various allocators and provides utility procedures -for dealing with memory, pointers and slices. +package mem implements various allocators and provides helpers for dealing with memory, pointers and slices. The documentation below describes basic concepts, applicable to the `mem` package. diff --git a/core/mem/tlsf/tlsf.odin b/core/mem/tlsf/tlsf.odin index 0ae8c28e0..792abb08e 100644 --- a/core/mem/tlsf/tlsf.odin +++ b/core/mem/tlsf/tlsf.odin @@ -1,3 +1,6 @@ +// package tlsf implements a Two Level Segregated Fit memory allocator. +package mem_tlsf + /* Copyright 2024 Jeroen van Rijn . Made available under Odin's BSD-3 license. @@ -7,9 +10,6 @@ Jeroen van Rijn: Source port */ -// package mem_tlsf implements a Two Level Segregated Fit memory allocator. -package mem_tlsf - import "base:intrinsics" import "base:runtime" diff --git a/core/mem/virtual/doc.odin b/core/mem/virtual/doc.odin index b4235b356..b423afde6 100644 --- a/core/mem/virtual/doc.odin +++ b/core/mem/virtual/doc.odin @@ -1,5 +1,5 @@ /* -package mem/virtual implements a platform agnostic way to reserve/commit/decommit virtual memory +package virtual implements a platform agnostic way to reserve/commit/decommit virtual memory. virtual.Arena usage diff --git a/core/net/doc.odin b/core/net/doc.odin index ed720c0ae..1d6ad776a 100644 --- a/core/net/doc.odin +++ b/core/net/doc.odin @@ -1,20 +1,5 @@ /* - Copyright 2022 Tetralux - Copyright 2022 Colin Davidson - Copyright 2022 Jeroen van Rijn . - Copyright 2024 Feoramund . - Made available under Odin's BSD-3 license. - - List of contributors: - Tetralux: Initial implementation - Colin Davidson: Linux platform code, OSX platform code, Odin-native DNS resolver - Jeroen van Rijn: Cross platform unification, code style, documentation - Feoramund: FreeBSD platform code -*/ - -/* -Package net implements cross-platform Berkeley Sockets, DNS resolution and associated procedures. -For other protocols and their features, see subdirectories of this package. +package net implements cross-platform Berkeley Sockets, DNS resolution and associated procedures. Features: - Supports Windows, Linux and OSX. @@ -44,3 +29,17 @@ or worse. This means that should you replace the temp allocator with an insuffic we'll do our best to loudly complain the first time you try it. */ package net + +/* + Copyright 2022 Tetralux + Copyright 2022 Colin Davidson + Copyright 2022 Jeroen van Rijn . + Copyright 2024 Feoramund . + Made available under Odin's BSD-3 license. + + List of contributors: + Tetralux: Initial implementation + Colin Davidson: Linux platform code, OSX platform code, Odin-native DNS resolver + Jeroen van Rijn: Cross platform unification, code style, documentation + Feoramund: FreeBSD platform code +*/ \ No newline at end of file diff --git a/core/odin/ast/ast.odin b/core/odin/ast/ast.odin index dbb7f5e52..d69a51f92 100644 --- a/core/odin/ast/ast.odin +++ b/core/odin/ast/ast.odin @@ -1,3 +1,4 @@ +// package ast implements the Abstract Syntax Tree for the Odin parser packages. package odin_ast import "core:odin/tokenizer" diff --git a/core/odin/doc-format/doc_format.odin b/core/odin/doc-format/doc_format.odin index e6804c981..b9a9cc2d3 100644 --- a/core/odin/doc-format/doc_format.odin +++ b/core/odin/doc-format/doc_format.odin @@ -1,3 +1,4 @@ +// package doc-format implements the .odin-doc file format, as used by these package docs at pkg.odin-lang.org. package odin_doc_format import "core:mem" diff --git a/core/odin/doc.odin b/core/odin/doc.odin new file mode 100644 index 000000000..69c40ccaf --- /dev/null +++ b/core/odin/doc.odin @@ -0,0 +1,2 @@ +// package odin implements a lexer and parser for the Odin language for the purposes of writing tooling. +package odin \ No newline at end of file diff --git a/core/odin/parser/parser.odin b/core/odin/parser/parser.odin index dab2d5d6a..e898b030f 100644 --- a/core/odin/parser/parser.odin +++ b/core/odin/parser/parser.odin @@ -1,3 +1,4 @@ +// package parser implements the *.odin file parser to be used in tooling. package odin_parser import "core:odin/ast" diff --git a/core/odin/tokenizer/tokenizer.odin b/core/odin/tokenizer/tokenizer.odin index a9d367a4d..6f4d4eb16 100644 --- a/core/odin/tokenizer/tokenizer.odin +++ b/core/odin/tokenizer/tokenizer.odin @@ -1,3 +1,4 @@ +// package tokenizer implements the tokenizer (lexer) for *.odin files, used to create tooling. package odin_tokenizer import "core:fmt" diff --git a/core/os/os.odin b/core/os/os.odin index fe08edff4..0c437c5ff 100644 --- a/core/os/os.odin +++ b/core/os/os.odin @@ -1,3 +1,4 @@ +// package os implements cross-platform OS interactions like file I/O. package os import "base:intrinsics"