cros-codecs: minor cargo doc cleanups

Use backticks around comments that use array syntax with [] to avoid
interpreting those as Markdown links.

Additionally, convert a few file headers to //! so they show up in the
generated docs.

BUG=None
TEST=tools/cargo-doc

Change-Id: I34799ff8e0e48b799f31255ae1ed84a0c18e8601
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3993931
Commit-Queue: Alexandre Courbot <acourbot@chromium.org>
Auto-Submit: Daniel Verkamp <dverkamp@chromium.org>
Reviewed-by: Alexandre Courbot <acourbot@chromium.org>

media/cros-codecs/src/decoders/h264/backends/stateless/dummy.rs

@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-// This file contains a dummy backend whose only purpose is to let the decoder
-// run so we can test it in isolation.
+//! This file contains a dummy backend whose only purpose is to let the decoder
+//! run so we can test it in isolation.
 
 use std::cell::Ref;
 use std::cell::RefCell;

media/cros-codecs/src/decoders/h264/parser.rs

@@ -606,7 +606,7 @@ pub struct Sps {
     /// QP′Y is defined in 7-38 as QP′Y = QPY + QpBdOffsetY
     qpprime_y_zero_transform_bypass_flag: bool,
 
-    /// Whether seq_scaling_list_present_flag[i] for i = 0..7 or i = 0..11 is
+    /// Whether `seq_scaling_list_present_flag[i]` for i = 0..7 or i = 0..11 is
     /// present or whether the sequence level scaling list shall be specified by
     /// Flat_4x4_16 for i = 0..5 and flat_8x8_16 for i = 6..11
     seq_scaling_matrix_present_flag: bool,
@@ -987,40 +987,40 @@ impl Default for Sps {
 #[derive(Clone, Debug, Default, PartialEq)]
 pub struct HrdParams {
     /// Plus 1 specifies the number of alternative CPB specifications in the
-    /// bitstream. The value of cpb_cnt_minus1 shall be in the range of 0 to 31,
+    /// bitstream. The value of `cpb_cnt_minus1` shall be in the range of 0 to 31,
     /// inclusive
     cpb_cnt_minus1: u8,
-    /// Together with bit_rate_value_minus1[ SchedSelIdx ] specifies the
-    /// maximum input bit rate of the SchedSelIdx-th CPB.
+    /// Together with `bit_rate_value_minus1[ SchedSelIdx ]` specifies the
+    /// maximum input bit rate of the `SchedSelIdx`-th CPB.
     bit_rate_scale: u8,
-    /// Together with cpb_size_value_minus1[ SchedSelIdx ] specifies the CPB
+    /// Together with `cpb_size_value_minus1[ SchedSelIdx ]` specifies the CPB
     /// size of the SchedSelIdx-th CPB.
     cpb_size_scale: u8,
 
-    /// [ SchedSelIdx ] (together with bit_rate_scale) specifies the maximum
+    /// `[ SchedSelIdx ]` (together with bit_rate_scale) specifies the maximum
     /// input bit rate for the SchedSelIdx-th CPB.
     bit_rate_value_minus1: [u32; 32],
-    /// [ SchedSelIdx ] is used together with cpb_size_scale to specify the
+    /// `[ SchedSelIdx ]` is used together with cpb_size_scale to specify the
     /// SchedSelIdx-th CPB size.
     cpb_size_value_minus1: [u32; 32],
-    /// [ SchedSelIdx ] equal to 0 specifies that to decode this bitstream by
-    /// the HRD using the SchedSelIdx-th CPB specification, the hypothetical
+    /// `[ SchedSelIdx ]` equal to 0 specifies that to decode this bitstream by
+    /// the HRD using the `SchedSelIdx`-th CPB specification, the hypothetical
     /// stream delivery scheduler (HSS) operates in an intermittent bit rate
-    /// mode. cbr_flag[ SchedSelIdx ] equal to 1 specifies that the HSS operates
+    /// mode. `cbr_flag[ SchedSelIdx ]` equal to 1 specifies that the HSS operates
     /// in a constant bit rate (CBR) mode
     cbr_flag: [bool; 32],
 
-    /// Specifies the length in bits of the initial_cpb_removal_delay[
-    /// SchedSelIdx ] and initial_cpb_removal_delay_offset[ SchedSelIdx ] syntax
+    /// Specifies the length in bits of the `initial_cpb_removal_delay[
+    /// SchedSelIdx ]` and `initial_cpb_removal_delay_offset[ SchedSelIdx ]` syntax
     /// elements of the buffering period SEI message.
     initial_cpb_removal_delay_length_minus1: u8,
-    /// Specifies the length in bits of the cpb_removal_delay syntax element.
+    /// Specifies the length in bits of the `cpb_removal_delay` syntax element.
     cpb_removal_delay_length_minus1: u8,
-    /// Specifies the length in bits of the dpb_output_delay syntax element.
+    /// Specifies the length in bits of the `dpb_output_delay` syntax element.
     dpb_output_delay_length_minus1: u8,
-    /// If greater than 0, specifies the length in bits of the time_offset
-    /// syntax element. time_offset_length equal to 0 specifies that the
-    /// time_offset syntax element is not present
+    /// If greater than 0, specifies the length in bits of the `time_offset`
+    /// syntax element. `time_offset_length` equal to 0 specifies that the
+    /// `time_offset` syntax element is not present
     time_offset_length: u8,
 }
 

media/cros-codecs/src/decoders/vp8/bool_decoder.rs

@@ -2,7 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-/// A VP8 boolean decoder based on the implementation in Chromium and GStreamer.
+//! A VP8 boolean decoder based on the implementation in Chromium and GStreamer.
+
 use std::{convert::TryFrom, io::Cursor};
 
 use anyhow::{anyhow, Result};

media/cros-codecs/src/decoders/vp8/probs.rs

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-/// VP8 probability tables as per the reference software and specification.
+//! VP8 probability tables as per the reference software and specification.
 
 pub const MV_UPDATE_PROBS: [[u8; 19]; 2] = [
     [

media/cros-codecs/src/decoders/vp9/backends/stateless/dummy.rs

@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-// This file contains a dummy backend whose only purpose is to let the decoder
-// run so we can test it in isolation.
+//! This file contains a dummy backend whose only purpose is to let the decoder
+//! run so we can test it in isolation.
 
 use std::cell::Ref;
 use std::cell::RefCell;