Doc fixes and improvements.

Author: nical

algorithms/src/splitter.rs

@@ -1,3 +1,5 @@
+/// Split paths with a line or line segment.
+
 use math::*;
 use geom::{Line, LineSegment};
 use std::cmp::PartialOrd;
@@ -16,7 +18,10 @@ struct IntersectingEdge {
     positive: bool,
 }
 
-/// A context object that can split the sub paths of `AdvancedPath`.
+/// A context object that can split paths.
+///
+/// When splitting several paths, reusing the `Splitter` object can improve performance
+/// by reusing memory allocations.
 pub struct Splitter {
     intersecting_edges: Vec<IntersectingEdge>,
     point_buffer: Vec<Point>,

src/lib.rs

@@ -1,7 +1,7 @@
 #![doc(html_logo_url = "https://nical.github.io/lyon-doc/lyon-logo.svg")]
 #![deny(bare_trait_objects)]
 
-//! 2d rendering on the GPU in rust.
+//! GPU-based 2D graphics rendering tools in Rust using path tessellation.
 //!
 //! ![logo](https://nical.github.io/lyon-doc/lyon-logo.svg)
 //!

tessellation/src/geometry_builder.rs

@@ -315,7 +315,7 @@ impl<VertexType, IndexType> VertexBuffers<VertexType, IndexType> {
 /// `BuffersBuilders` record the vertex offset from when they are created so that algorithms using
 /// them don't need to worry about offsetting indices if some geometry was added beforehand. This
 /// means that from the point of view of a `BuffersBuilder` user, the first added vertex is at always
-/// offset at the offset 0 and `VertexBuilfer` takes care of translating indices adequately.
+/// offset at the offset 0 and `VertexBuilder` takes care of translating indices adequately.
 ///
 /// Often, algorithms are built to generate vertex positions without knowledge of eventual other
 /// vertex attributes. The `VertexConstructor` does the translation from generic `Input` to `VertexType`.

tessellation/src/lib.rs

@@ -232,6 +232,9 @@ pub enum TessellationError {
     Internal(InternalError)
 }
 
+/// Something unexpectedly put the tessellator in a bad state.
+///
+/// If you run into this error code, please [file an issue](https://github.com/nical/lyon/issues).
 #[derive(Clone, Debug, PartialEq)]
 pub enum InternalError {
     E01,