various doc improvements

I bumped the minimum Rust version because I'm taking advantage of
the rustdoc linking added in Rust 1.48:
https://blog.rust-lang.org/2020/11/19/Rust-1.48.html#easier-linking-in-rustdoc
This commit is contained in:
Scott Lamb
2021-04-10 17:34:52 -07:00
parent 98d106553a
commit 2936c138c5
17 changed files with 119 additions and 54 deletions

View File

@@ -1,7 +1,16 @@
// This file is part of Moonfire NVR, a security camera network video recorder.
// Copyright (C) 2020 The Moonfire NVR Authors; see AUTHORS and LICENSE.txt.
// Copyright (C) 2021 The Moonfire NVR Authors; see AUTHORS and LICENSE.txt.
// SPDX-License-Identifier: GPL-v3.0-or-later WITH GPL-3.0-linking-exception.
//! Moonfire NVR's persistence layer.
//!
//! This manages both the SQLite database and the sample file directory.
//! Everything dealing with either flows through this crate. It keeps in-memory
//! state both as indexes and to batch SQLite database transactions.
//!
//! The core recording design is described in `design/recording.md` and is
//! mostly in the `db` module.
#![cfg_attr(all(feature = "nightly", test), feature(test))]
pub mod auth;