clippy: Add missing Error doc and enable lint

lint: missing_errors_doc

src/lib.rs

@@ -17,6 +17,7 @@
 #![deny(clippy::if_not_else)]
 #![deny(clippy::match_same_arms)]
 #![deny(clippy::missing_panics_doc)]
+#![deny(clippy::missing_errors_doc)]
 #![deny(clippy::missing_fields_in_debug)]
 #![deny(clippy::must_use_candidate)]
 #![deny(clippy::or_fun_call)]

src/srt.rs

@@ -4,6 +4,9 @@ use std::io;
 use crate::time::TimeSpan;
 
 /// Write subtitles in srt format
+/// # Errors
+///
+/// Will return `Err` if write in `writer` return an `Err`.
 pub fn write_srt(
     data: &[(TimeSpan, String)],
     writer: &mut impl io::Write,

src/vobsub/palette.rs

@@ -34,6 +34,9 @@ fn hex_rgb(input: &[u8]) -> IResult<&[u8], Rgb<u8>> {
 pub type Palette = [Rgb<u8>; 16];
 
 /// Parse a text as Palette
+/// # Errors
+///
+/// Will return `Err` if the input don't have 16 entries.
 pub fn palette(input: &[u8]) -> IResult<&[u8], Palette> {
     let res = map_res(separated_list0(tag(b", "), hex_rgb), |vec: Vec<Rgb<u8>>| {
         if vec.len() != 16 {

src/vobsub/probe.rs

@@ -21,6 +21,9 @@ fn has_magic(path: &Path, magic: &[u8]) -> Result<bool, SubError> {
 }
 
 /// Does the specified path appear to point to an `*.idx` file?
+/// # Errors
+///
+/// Will return `Err` if the file can't be read.
 pub fn is_idx_file<P: AsRef<Path>>(path: P) -> Result<bool, SubError> {
     has_magic(path.as_ref(), b"# VobSub index file")
 }
@@ -29,6 +32,10 @@ pub fn is_idx_file<P: AsRef<Path>>(path: P) -> Result<bool, SubError> {
 ///
 /// Note that this may (or may not) return false positives for certain
 /// MPEG-2 related formats.
+///
+/// # Errors
+///
+/// Will return `Err` if the file can't be read.
 pub fn is_sub_file<P: AsRef<Path>>(path: P) -> Result<bool, SubError> {
     has_magic(path.as_ref(), &[0x00, 0x00, 0x01, 0xba])
 }