Pārlūkot izejas kodu

More package lines.

Jeroen van Rijn 3 dienas atpakaļ
vecāks
revīzija
8a35acd506

+ 2 - 0
core/hash/doc.odin

@@ -0,0 +1,2 @@
+// package hash implements crc32, crc64, adler32, djb, fnv, jenkins, murmur and other hashes.
+package hash

+ 2 - 0
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

+ 1 - 2
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`
 The documentation below describes basic concepts, applicable to the `mem`
 package.
 package.

+ 3 - 3
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 <[email protected]>.
 	Copyright 2024 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
 	Made available under Odin's BSD-3 license.
@@ -7,9 +10,6 @@
 		Jeroen van Rijn: Source port
 		Jeroen van Rijn: Source port
 */
 */
 
 
-// package mem_tlsf implements a Two Level Segregated Fit memory allocator.
-package mem_tlsf
-
 import "base:intrinsics"
 import "base:intrinsics"
 import "base:runtime"
 import "base:runtime"
 
 

+ 1 - 1
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
 virtual.Arena usage

+ 15 - 16
core/net/doc.odin

@@ -1,20 +1,5 @@
 /*
 /*
-	Copyright 2022 Tetralux        <[email protected]>
-	Copyright 2022 Colin Davidson  <[email protected]>
-	Copyright 2022 Jeroen van Rijn <[email protected]>.
-	Copyright 2024 Feoramund       <[email protected]>.
-	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:
 Features:
 - Supports Windows, Linux and OSX.
 - 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.
 we'll do our best to loudly complain the first time you try it.
 */
 */
 package net
 package net
+
+/*
+	Copyright 2022 Tetralux        <[email protected]>
+	Copyright 2022 Colin Davidson  <[email protected]>
+	Copyright 2022 Jeroen van Rijn <[email protected]>.
+	Copyright 2024 Feoramund       <[email protected]>.
+	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
+*/

+ 1 - 0
core/odin/ast/ast.odin

@@ -1,3 +1,4 @@
+// package ast implements the Abstract Syntax Tree for the Odin parser packages.
 package odin_ast
 package odin_ast
 
 
 import "core:odin/tokenizer"
 import "core:odin/tokenizer"

+ 1 - 0
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
 package odin_doc_format
 
 
 import "core:mem"
 import "core:mem"

+ 2 - 0
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

+ 1 - 0
core/odin/parser/parser.odin

@@ -1,3 +1,4 @@
+// package parser implements the *.odin file parser to be used in tooling.
 package odin_parser
 package odin_parser
 
 
 import "core:odin/ast"
 import "core:odin/ast"

+ 1 - 0
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
 package odin_tokenizer
 
 
 import "core:fmt"
 import "core:fmt"

+ 1 - 0
core/os/os.odin

@@ -1,3 +1,4 @@
+// package os implements cross-platform OS interactions like file I/O.
 package os
 package os
 
 
 import "base:intrinsics"
 import "base:intrinsics"