[Merged by Bors] - Complete inline documentation for bevy_audio #3510
Conversation
NiklasEi
force-pushed
the
document_bevy_audio
branch
from
9bfa358
to
2d14fc5
Compare
NiklasEi
force-pushed
the
document_bevy_audio
branch
from
2d14fc5
to
e15bd25
Compare
alice-i-cecile
added
A-Audio
NiklasEi
removed
the
C-Code-Quality
| @@ -43,9 +50,12 @@ impl AssetLoader for Mp3Loader { | |||
| } | |||
| } | |||
|
|
|||
| /// Mark a type as decodable | |||
There was a problem hiding this comment.
This could use more information about what exactly it means for something to be "decodable".
Many of the readers will have 0 audio experience.
There was a problem hiding this comment.
I find it very hard to specify because this trait is so generic. There is no restriction on the Decoder type in the trait.
The restrictions come later in the implementations of AudioOutput and Audio. There we require the Decoder to yield some rodio types.
There was a problem hiding this comment.
I moved the trait bounds from the implementations to the decodable trait. Now it should be a bit clearer what the trait means and we have a lot less duplication in where clauses.
This is not the same API, but I couldn't think of a use case where it would be a problem to have the rodio trait bounds on the Decodable trait directly.
What do you think?
There was a problem hiding this comment.
This will lead to a little bit of generic-pollution, but the boilerplate reduction and clarity are worth it here IMO.
NiklasEi
added
the
C-Code-Quality
| pub bytes: Arc<[u8]>, | ||
| bytes: Arc<[u8]>, |
There was a problem hiding this comment.
why removing the pub? doesn't it allow someone to generate an audio source instead of loading it from a file?
There was a problem hiding this comment.
Good point. I made it public again.
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
bors r+ |
# Objective Part of #3492 - Complete inline documentation of `bevy_audio` ## Solution - Added inline documentation to all public parts of `bevy_audio` - Added a few inline examples at important places - Some renaming for clarity (e.g. `AudioLoader` and generics) - added `#![warn(missing_docs)]` and `#![forbid(unsafe_code)]` to `bevy_audio` I also tried adding support for the other vorbis file endings `.oga` and `.spx` to the `AudioLoader` (see `file endings` at https://tools.ietf.org/html/rfc5334#section-10.3), but the `rodio` decoder does not seem to support those.
bors
bot
changed the title
Objective
Part of #3492
bevy_audioSolution
bevy_audioAudioLoaderand generics)#![warn(missing_docs)]and#![forbid(unsafe_code)]tobevy_audioI also tried adding support for the other vorbis file endings
.ogaand.spxto theAudioLoader(seefile endingsat https://tools.ietf.org/html/rfc5334#section-10.3), but therodiodecoder does not seem to support those.