From 07d3fa7289c6f063e4bf26a4b514c0b62044019e Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Sat, 24 Nov 2018 17:52:43 +0100 Subject: [PATCH] add some inline documentation --- src/lib.rs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 3ebf84fc..f67f20df 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,15 @@ pub mod static_map; +/// API definition helper +/// +/// This module contains helper classes to define REST APIs. Method +/// parameters and return types are described using a +/// [Schema](schema/enum.Schema.html). +/// +/// The [Router](router/struct.Router.html) is used to define a +/// hierarchy of API entries, and provides ways to find an API +/// definition by path. + #[macro_use] pub mod api {