bevy/crates
Niklas Eicker f9b51ca602 Complete inline documentation for bevy_audio (#3510)
# 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.
2022-01-05 22:30:15 +00:00
..
bevy_app Fix doc_markdown lints in bevy_app (#3467) 2021-12-30 09:08:19 +00:00
bevy_asset Documented Handles and Assets (#3348) 2022-01-04 23:38:39 +00:00
bevy_audio Complete inline documentation for bevy_audio (#3510) 2022-01-05 22:30:15 +00:00
bevy_core Remove Bytes, FromBytes, Labels, EntityLabels. Document rest of bevy_core and enable warning on missing docs. (#3521) 2022-01-02 20:36:40 +00:00
bevy_core_pipeline make sub_app return an &App and add sub_app_mut() -> &mut App (#3309) 2021-12-24 06:57:30 +00:00
bevy_crevice Update nalgebra requirement from 0.29.0 to 0.30.0 (#3540) 2022-01-03 08:33:15 +00:00
bevy_derive Remove Bytes, FromBytes, Labels, EntityLabels. Document rest of bevy_core and enable warning on missing docs. (#3521) 2022-01-02 20:36:40 +00:00
bevy_diagnostic Fix doc_markdown lints in bevy_diagnostic (#3472) 2021-12-29 17:38:08 +00:00
bevy_dylib Updated bevy_dylib documentation and added missing_doc warning. (#3515) 2022-01-02 10:51:08 +00:00
bevy_dynamic_plugin Update to edition 2021 on master (#3028) 2021-10-27 00:12:14 +00:00
bevy_ecs Removal detection cleanup (#3010) 2022-01-05 22:06:38 +00:00
bevy_ecs_compile_fail_tests Fix clippy lints for 1.57 (#3238) 2021-12-02 23:40:37 +00:00
bevy_gilrs enable wasm-bindgen feature on gilrs (#3420) 2021-12-23 19:19:14 +00:00
bevy_gltf load names of lights from gltf (#3553) 2022-01-05 03:27:17 +00:00
bevy_input Fix doc_markdown lints in bevy_input (#3475) 2021-12-29 17:38:10 +00:00
bevy_internal Added missing docs to bevy_internal and added warn on missing docs (#3514) 2022-01-01 21:22:04 +00:00
bevy_log Fix doc_markdown lints in bevy_log (#3476) 2021-12-29 17:38:11 +00:00
bevy_macro_utils Use fully-qualified type names in proc macro. (#3544) 2022-01-04 19:49:37 +00:00
bevy_math Replace old renderer with new renderer (#3312) 2021-12-14 03:58:23 +00:00
bevy_pbr Configurable wgpu features/limits priority (#3452) 2022-01-04 20:08:12 +00:00
bevy_reflect Implement ReflectValue serialization for Duration (#3318) 2021-12-29 21:04:26 +00:00
bevy_render Add MapMode to wgpu reexports (#3558) 2022-01-05 19:19:22 +00:00
bevy_scene Renamed Entity::new to Entity::from_raw (#3465) 2021-12-29 20:49:00 +00:00
bevy_sprite Fix doc_markdown lints in bevy_sprite (#3480) 2021-12-29 18:49:43 +00:00
bevy_tasks Fix doc_markdown lints in bevy_tasks (#3481) 2021-12-29 17:38:13 +00:00
bevy_text Fix doc_markdown lints in bevy_text (#3482) 2022-01-05 22:30:12 +00:00
bevy_transform Fix doc_markdown lints in bevy_transform (#3483) 2021-12-30 09:23:17 +00:00
bevy_ui Fix doc_markdown lints in bevy_ui (#3484) 2022-01-05 22:30:14 +00:00
bevy_utils Fix doc_markdown lints in bevy_utils (#3485) 2021-12-30 09:23:18 +00:00
bevy_window Added set_cursor_icon(...) to Window (#3395) 2021-12-20 22:04:45 +00:00
bevy_winit Added set_cursor_icon(...) to Window (#3395) 2021-12-20 22:04:45 +00:00