From cf62054eb8cd152eaff71172a427132cda2be208 Mon Sep 17 00:00:00 2001 From: "Tristan B. Velloza Kildaire" Date: Wed, 5 Apr 2023 08:47:51 +0200 Subject: [PATCH] Encoding - Added module-level documentation Exceptions - Added module-level documentation Queue - Added module-level documentation Package (`tristanable.manager`) - Added module-level documentation --- source/tristanable/encoding.d | 3 +++ source/tristanable/exceptions.d | 3 +++ source/tristanable/manager/package.d | 4 ++++ source/tristanable/queue.d | 3 +++ 4 files changed, 13 insertions(+) diff --git a/source/tristanable/encoding.d b/source/tristanable/encoding.d index 64005c3..8af5329 100644 --- a/source/tristanable/encoding.d +++ b/source/tristanable/encoding.d @@ -1,3 +1,6 @@ +/** + * Encoding/decoding of the tristanable format + */ module tristanable.encoding; import std.conv : to; diff --git a/source/tristanable/exceptions.d b/source/tristanable/exceptions.d index 992f982..481dd9c 100644 --- a/source/tristanable/exceptions.d +++ b/source/tristanable/exceptions.d @@ -1,3 +1,6 @@ +/** + * Error handling type definitions + */ module tristanable.exceptions; public enum ErrorType diff --git a/source/tristanable/manager/package.d b/source/tristanable/manager/package.d index fc15e0f..84bb7fb 100644 --- a/source/tristanable/manager/package.d +++ b/source/tristanable/manager/package.d @@ -1,3 +1,7 @@ +/** + * Interface which manages a provided socket + * and enqueuing and dequeuing of queues + */ module tristanable.manager; public import tristanable.manager.manager : Manager; \ No newline at end of file diff --git a/source/tristanable/queue.d b/source/tristanable/queue.d index 155de80..eec3efd 100644 --- a/source/tristanable/queue.d +++ b/source/tristanable/queue.d @@ -1,3 +1,6 @@ +/** + * A queue of queue items all of the same tag + */ module tristanable.queue; // TODO: Examine the below import which seemingly fixes stuff for libsnooze