Formulaic doc comments for other crates

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/apitest/apitest.rs b/apitest/apitest.rs
index 5eec89ed37125b1d80f0c7e0c118bc152acdad09..361a9945c1c80f09e28f2faf8cad8e906b308b14 100644 (file)
--- a/apitest/apitest.rs
+++ b/apitest/apitest.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 // ==================== namespace preparation ====================
 
 pub mod imports {

diff --git a/base/lib.rs b/base/lib.rs
index b65b228f98bff107e371a1e751a260b685360848..2366f15c02b4ccc981f23f94d70ee54afcaefbe1 100644 (file)
--- a/base/lib.rs
+++ b/base/lib.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 #![allow(clippy::redundant_closure_call)]
 #![allow(clippy::writeln_empty_string)]
 

diff --git a/jstest/jstest.rs b/jstest/jstest.rs
index b352cc15c096ba2f026f2c32d017e85950f1bc1a..a1d05335568f12ea6d540844ca22343bb44b2753 100644 (file)
--- a/jstest/jstest.rs
+++ b/jstest/jstest.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 #![allow(clippy::or_fun_call)]
 #![allow(clippy::unnecessary_operation)] // trips on #[throws(Explode)]
 

diff --git a/wasm/wasm.rs b/wasm/wasm.rs
index 251ec7cb5c91d9692b1410a1cf7213b489a58d11..c7db365b321f7a0f09a68045b051c68f4e6dccca 100644 (file)
--- a/wasm/wasm.rs
+++ b/wasm/wasm.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 #![allow(clippy::unused_unit)] // #[wasm_bindgen] produces these?
 
 use otter_base::imports::*;

diff --git a/wdriver/wdriver.rs b/wdriver/wdriver.rs
index 35c43b0b7faadcf4f9237e2ec2d16163cd319f4f..0b47d7d98e8b5afea3e26f00250a33d9ff20fc09 100644 (file)
--- a/wdriver/wdriver.rs
+++ b/wdriver/wdriver.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 #![allow(clippy::or_fun_call)]
 #![allow(clippy::unnecessary_operation)] // trips on #[throws(Explode)]
 #![allow(clippy::no_effect)] // trips on #[throws(Explode)]