diff options
author | Vincent Ambo <mail@tazj.in> | 2018-09-26T16·04+0200 |
---|---|---|
committer | Vincent Ambo <mail@tazj.in> | 2018-09-26T16·04+0200 |
commit | fe97c712cc64582cdd33dda8845820e479f83a39 (patch) | |
tree | f6b30d8fcee68f7c7c58469999d2bf33bfe82bdf | |
parent | 965574913e835e746b8e71b62eb76898a6686ded (diff) |
docs: Add rustdoc header lines as expected by the format
These are rendered in the rustdoc crate overview sidebar.
-rw-r--r-- | finito-core/src/lib.rs | 2 | ||||
-rw-r--r-- | finito-door/src/lib.rs | 2 | ||||
-rw-r--r-- | finito-postgres/src/lib.rs | 2 |
3 files changed, 6 insertions, 0 deletions
diff --git a/finito-core/src/lib.rs b/finito-core/src/lib.rs index 0fdb2bd912b8..2f27a2bdf958 100644 --- a/finito-core/src/lib.rs +++ b/finito-core/src/lib.rs @@ -1,3 +1,5 @@ +//! Finito's core finite-state machine abstraction. +//! //! # What & why? //! //! Most processes that occur in software applications can be modeled diff --git a/finito-door/src/lib.rs b/finito-door/src/lib.rs index 0137a6026a78..296ce72b26d6 100644 --- a/finito-door/src/lib.rs +++ b/finito-door/src/lib.rs @@ -1,3 +1,5 @@ +//! Example implementation of a lockable door in Finito +//! //! # What & why? //! //! This module serves as a (hopefully simple) example of how to diff --git a/finito-postgres/src/lib.rs b/finito-postgres/src/lib.rs index 152592405534..b7a0c4540f74 100644 --- a/finito-postgres/src/lib.rs +++ b/finito-postgres/src/lib.rs @@ -1,3 +1,5 @@ +//! PostgreSQL-backed persistence for Finito state machines +//! //! This module implements ... TODO when I can write again. #[macro_use] extern crate postgres; |