add some inline documentation

This commit is contained in:
Dietmar Maurer 2018-11-24 17:52:43 +01:00
parent 6656ba9d32
commit 07d3fa7289
1 changed files with 10 additions and 0 deletions

View File

@ -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 {