RustAudio / coreaudio-rs

A friendly rust interface to Apple's Core Audio API.
Apache License 2.0
218 stars 44 forks source link

Fix of 4 documentation warnings #95

Closed apps4uco closed 1 year ago

apps4uco commented 1 year ago

Fix for the following warnings::

warning: unclosed HTML tag `S`
  --> src/audio_unit/stream_format.rs:19:35
   |
19 | /// `bytes_per_packet` = size_of::<S>()
   |                                   ^^^
   |
   = note: `#[warn(rustdoc::invalid_html_tags)]` on by default
help: try marking as source code
   |
19 | /// `bytes_per_packet` = `size_of::<S>`()
   |                          +            +

warning: unclosed HTML tag `S`
  --> src/audio_unit/stream_format.rs:20:34
   |
20 | /// `bytes_per_frame` = size_of::<S>()
   |                                  ^^^
   |
help: try marking as source code
   |
20 | /// `bytes_per_frame` = `size_of::<S>`()
   |                         +            +

warning: unclosed HTML tag `S`
  --> src/audio_unit/stream_format.rs:22:35
   |
22 | /// `bits_per_channel` = size_of::<S>() / channels_per_frame * 8
   |                                   ^^^
   |
help: try marking as source code
   |
22 | /// `bits_per_channel` = `size_of::<S>`() / channels_per_frame * 8
   |                          +            +

warning: this URL is not a hyperlink
   --> src/audio_unit/types.rs:442:13
    |
442 | ...ee https://developer.apple.com/library/content/documentation/MusicAudio/Conceptual/AudioUnitHostingGuide_iOS/UsingSpecificAudioUnits/UsingSpecificAudioUnits.html
    |       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://developer.apple.com/library/content/documentation/MusicAudio/Conceptual/AudioUnitHostingGuide_iOS/UsingSpecificAudioUnits/UsingSpecificAudioUnits.html>`
    |
    = note: bare URLs are not automatically turned into clickable links
    = note: `#[warn(rustdoc::bare_urls)]` on by default

warning: `coreaudio-rs` (lib doc) generated 4 warnings (run `cargo fix --lib -p coreaudio-rs` to apply 1 suggestion)