summaryrefslogtreecommitdiff
path: root/morphology-img/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'morphology-img/src/lib.rs')
-rw-r--r--morphology-img/src/lib.rs31
1 files changed, 28 insertions, 3 deletions
diff --git a/morphology-img/src/lib.rs b/morphology-img/src/lib.rs
index 28dfc58..a8a4acd 100644
--- a/morphology-img/src/lib.rs
+++ b/morphology-img/src/lib.rs
@@ -1,9 +1,34 @@
+//! Converts meta-affine sequences to SVG visualizations via LilyPond markup.
+//!
+//! This library provides a public API for converting structures from the
+//! morphology crate into SVG images. All LilyPond-specific implementation
+//! details are kept internal.
+//!
+//! # Public API
+//!
+//! The primary function is [`sequence_to_markup`] which converts a
+//! meta-affine `Sequence` directly to a LilyPond markup string.
+//!
+//! # Architecture
+//!
+//! - **Input**: Only meta-affine types (`Sequence`, `Value`)
+//! - **Output**: File paths or markup strings
+//! - **Hidden**: All LilyPond-specific types and implementation details
+
pub mod error;
-pub mod pitch;
+
+#[doc(hidden)]
+pub mod note;
+
+#[doc(hidden)]
pub mod template;
+
+#[doc(hidden)]
pub mod file_gen;
+
+#[doc(hidden)]
pub mod render;
-// Re-export key types
+// Public API - only export what external clients should use
pub use error::RenderError;
-pub use pitch::{LilyPondPitch, LilyPondNote, Duration};
+pub use note::sequence_to_markup;