mirror of
https://github.com/Ed94/Odin.git
synced 2026-07-28 18:30:06 +00:00
Further overhaul of package line comments.
This commit is contained in:
@@ -1,3 +1,4 @@
|
||||
// `Base32` encoding and decoding, as specified in `RFC 4648`.
|
||||
package encoding_base32
|
||||
|
||||
// Base32 encoding/decoding implementation as specified in RFC 4648.
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
// package base32 implements Base32 encoding and decoding, as specified in RFC 4648.
|
||||
package encoding_base32
|
||||
@@ -1,3 +1,4 @@
|
||||
// `Base64` encoding and decoding.
|
||||
package encoding_base64
|
||||
|
||||
import "core:io"
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
// package base64 implements Base64 encoding and decoding.
|
||||
package encoding_base64
|
||||
@@ -1,4 +1,4 @@
|
||||
// package cbor implements encoding and decoding types from/into RCF 8949 compatible CBOR binary.
|
||||
// Encoding and decoding types from/into `RCF 8949` compatible `CBOR` binary.
|
||||
package encoding_cbor
|
||||
/*
|
||||
Package cbor encodes, decodes, marshals and unmarshals types from/into RCF 8949 compatible CBOR binary.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
package csv reads and writes comma-separated values (CSV) files.
|
||||
Reader and writer for comma-separated values (`CSV`) files, per `RFC 4180`.
|
||||
This package supports the format described in [[ RFC 4180; https://tools.ietf.org/html/rfc4180.html ]]
|
||||
|
||||
Example:
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
Package endian implements a simple translation between bytes and numbers with specific endian encodings.
|
||||
A simple translation between bytes and numbers with specific endian encodings.
|
||||
|
||||
Example:
|
||||
buf: [100]u8
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
package entity implements a unicode `&entity;` encoder and decoder.
|
||||
Encode and decode `rune`s to/from a Unicode `&entity;`.
|
||||
|
||||
This code has several procedures to map unicode runes to/from different textual encodings.
|
||||
- SGML/XML/HTML entity
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// package hex implements encoding and decoding of hex-encoded binary, e.g. `0x23` -> `#`.
|
||||
// Encoding and decoding of hex-encoded binary, e.g. `0x23` -> `#`.
|
||||
package encoding_hex
|
||||
|
||||
import "core:io"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
package hxa implements Eskil Steenberg's HxA 3D asset interchange format.
|
||||
Eskil Steenberg's `HxA` 3D asset interchange format.
|
||||
|
||||
HxA is a interchangeable graphics asset format.
|
||||
Designed by Eskil Steenberg. @quelsolaar / eskil 'at' obsession 'dot' se / www.quelsolaar.com
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// package ini implements a variant of the `.ini` file format with `key = value` entries in `[sections]`.
|
||||
// Reader and writer for a variant of the `.ini` file format with `key = value` entries in `[sections]`.
|
||||
package encoding_ini
|
||||
|
||||
import "base:runtime"
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
// package json implements encoding and decoding JSON in strict JSON, JSON5 and BitSquid variants.
|
||||
package encoding_json
|
||||
@@ -1,3 +1,4 @@
|
||||
// Encoding and decoding JSON in strict `JSON`, `JSON5` and `BitSquid` variants.
|
||||
package encoding_json
|
||||
|
||||
import "core:strings"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
package uuid implements Universally Unique Identifiers according to RFC 4122, with additions from RFC 9562.
|
||||
Universally Unique Identifiers (`UUID`) according to `RFC 4122`, with additions from `RFC 9562`.
|
||||
|
||||
The UUIDs are textually represented and read in the following string format:
|
||||
`00000000-0000-v000-V000-000000000000`
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
package uuid/legacy implements versions 3 and 5 of UUID generation, both of
|
||||
which are using hashing algorithms (MD5 and SHA1, respectively) that are known
|
||||
these days to no longer be secure.
|
||||
Versions 3 and 5 of `UUID` generation, both of which use legacy (`MD5` + `SHA1`) hashes.
|
||||
Those are known these days to no longer be secure.
|
||||
*/
|
||||
package uuid_legacy
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
package varint implements LEB128 variable integer encoding and decoding, as used by DWARF & DEX files.
|
||||
`LEB128` variable integer encoding and decoding, as used by `DWARF` & `DEX` files.
|
||||
|
||||
Author of this Odin package: Jeroen van Rijn
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
package xml implements a parser for a useful subset of the XML specification.
|
||||
A parser for a useful subset of the `XML` specification.
|
||||
|
||||
A from-scratch XML implementation, loosely modelled on the [[ spec; https://www.w3.org/TR/2006/REC-xml11-20060816 ]].
|
||||
|
||||
|
||||
Reference in New Issue
Block a user