Link doc lines to source specifications.

This commit is contained in:
Jeroen van Rijn
2025-10-10 18:29:52 +02:00
parent 998fbdc5c0
commit 236111864e
6 changed files with 7 additions and 10 deletions

View File

@@ -1,7 +1,5 @@
/*
`Base32` encoding and decoding, as specified in `RFC 4648`.
[[ RFC 4648; https://www.rfc-editor.org/rfc/rfc4648.html ]]
`Base32` encoding and decoding, as specified in [[ RFC 4648; https://www.rfc-editor.org/rfc/rfc4648.html ]].
A secondary param can be used to supply a custom alphabet to `encode` and a matching decoding table to `decode`.

View File

@@ -1,5 +1,5 @@
/*
Encodes and decodes types from/into `RCF 8949` compatible `CBOR` binary.
Encodes and decodes types from/into [[ RCF 8949; https://www.rfc-editor.org/rfc/rfc8949.html ]] compatible `CBOR` binary.
Also provided are conversion to and from JSON and the CBOR diagnostic format.

View File

@@ -1,6 +1,5 @@
/*
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 ]]
Reader and writer for comma-separated values (`CSV`) files, per [[ RFC 4180 ; https://tools.ietf.org/html/rfc4180.html ]].
Example:
package main

View File

@@ -1,5 +1,5 @@
/*
Encoding and decoding JSON in strict `JSON`, `JSON5` and `BitSquid` variants.
Encoding and decoding JSON in strict `JSON`, [[ JSON5 ; https://json5.org/ ]] and [[ BitSquid ; https://bitsquid.blogspot.com/2009/10/simplified-json-notation.html ]] variants.
Using one of these `Specification`s.
JSON

View File

@@ -1,5 +1,5 @@
/*
Universally Unique Identifiers (`UUID`) according to `RFC 4122`, with additions from `RFC 9562`.
Universally Unique Identifiers (`UUID`) according to [[ RFC 4122 ; https://tools.ietf.org/html/rfc4122.html ]], with additions from [[ RFC 9562 ; https://tools.ietf.org/html/rfc9562.html ]].
The UUIDs are textually represented and read in the following string format:
`00000000-0000-v000-V000-000000000000`

View File

@@ -1,7 +1,7 @@
/*
`OpenSimplex2` noise algorithm.
[[ OpenSimplex2 ; https://github.com/KdotJPG/OpenSimplex2 ]] noise algorithm.
Ported from [[ https://github.com/KdotJPG/OpenSimplex2 }].
Ported from [[ https://github.com/KdotJPG/OpenSimplex2 ]].
Copyright 2022 Yuki2 [[ https://github.com/NoahR02 ]]
*/
package math_noise