From 61a11550b2c1ea6b8eec939effc793ae25bb6f33 Mon Sep 17 00:00:00 2001
From: Hanno Braun <hanno@braun-odw.eu>
Date: Wed, 13 Apr 2022 13:48:21 +0200
Subject: [PATCH] Document `fj-export`

---
 fj-export/src/lib.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/fj-export/src/lib.rs b/fj-export/src/lib.rs
index cb0a9cf44..635802f8c 100644
--- a/fj-export/src/lib.rs
+++ b/fj-export/src/lib.rs
@@ -1,8 +1,16 @@
+//! Exporting Fornjot models to external files
+
+#![deny(missing_docs)]
+
 use std::path::Path;
 
 use fj_interop::mesh::Mesh;
 use fj_math::Point;
 
+/// Export the provided mesh to the file at the given path
+///
+/// Currently only 3MF is supported as an export format. The file extension of
+/// the provided path is ignored.
 pub fn export(mesh: &Mesh<Point<3>>, path: &Path) -> Result<(), Error> {
     let vertices = mesh.vertices().map(|vertex| vertex.into()).collect();