Add idiomatic documentation to Go, Java, Python, and Rust clients

This commit is contained in:
Joseph Doherty
2026-04-30 12:04:46 -04:00
parent eed1e88a37
commit 8d3352f2c6
44 changed files with 1631 additions and 102 deletions
+18 -3
View File
@@ -1,8 +1,15 @@
//! Rust client scaffold for MXAccess Gateway.
//! Rust client for the MXAccess Gateway.
//!
//! The crate compiles generated `tonic` bindings from the shared gateway
//! protobuf contracts and exposes a small handwritten surface for future client
//! implementation work.
//! protobuf contracts and exposes a small handwritten surface — connection
//! options, an authentication interceptor, gateway and Galaxy Repository
//! clients, an `MxValue` builder/projection, and protocol-error types — that
//! application code can use without touching the generated modules directly.
//!
//! See the project root `RustClientDesign.md` for the design rationale and
//! the cross-language client matrix.
#![warn(missing_docs)]
pub mod auth;
pub mod client;
@@ -14,11 +21,19 @@ pub mod session;
pub mod value;
pub mod version;
#[doc(inline)]
pub use auth::{ApiKey, AuthInterceptor};
#[doc(inline)]
pub use client::{EventStream, GatewayClient};
#[doc(inline)]
pub use error::{CommandError, Error};
#[doc(inline)]
pub use galaxy::{DeployEventStream, GalaxyClient};
#[doc(inline)]
pub use options::ClientOptions;
#[doc(inline)]
pub use session::Session;
#[doc(inline)]
pub use value::{MxArrayProjection, MxArrayValue, MxStatus, MxValue, MxValueProjection};
#[doc(inline)]
pub use version::{CLIENT_VERSION, GATEWAY_PROTOCOL_VERSION, WORKER_PROTOCOL_VERSION};