bevy/crates
KDecay 506642744c docs: Fix private doc links and enable CI test (#3743)
# Objective

Fixes #3566

## Solution

- [x] Fix broken links in private docs.
- [x] Add the `--document-private-items` flag to the CI.

## Note

The following was said by @killercup in #3566:

> I don't have time to confirm this but I assume that linking to private items throws an error/warning when just running cargo doc, and --document-private-item might actually hide that warning. So to test this, you'd have to run it twice.

I tested this and this is thankfully not the case. If you are linking to a private item you will get a warning no matter if you run `cargo doc` or `cargo doc --document-private-items`.

### Example

I added `struct Test;` to `bevy_core/src/name.rs` and linked to it inside of a doc comment using ``[`Test`]``. After that I ran `cargo doc -p bevy_core --document-private-items` using `RUSTDOCFLAGS="-D warnings"` and got the following output (note the last sentence):

```rust
error: public documentation for `Name` links to private item `Test`
  --> crates/bevy_core/src/name.rs:11:82
   |
11 | /// Component used to identify an entity. Stores a hash for faster comparisons [`Test`]
   |                                                                                  ^^^^ this item is private
   |
   = note: `-D rustdoc::private-intra-doc-links` implied by `-D warnings`
   = note: this link resolves only because you passed `--document-private-items`, but will break without
```
2022-02-02 21:47:29 +00:00
..
bevy_app Document sub apps (#3403) 2022-01-14 23:14:42 +00:00
bevy_asset Add a warning when watch_for_changes has no effect (#3684) 2022-01-21 00:29:29 +00:00
bevy_audio Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_core fix timer test to be less reliant on float precision (#3789) 2022-01-28 16:17:54 +00:00
bevy_core_pipeline Update ClearColor Resource docs (#3842) 2022-02-02 21:29:48 +00:00
bevy_crevice Don't panic in macro shape validation (#3647) 2022-01-15 22:14:43 +00:00
bevy_derive Don't panic in macro shape validation (#3647) 2022-01-15 22:14:43 +00:00
bevy_diagnostic Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_dylib Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_dynamic_plugin Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_ecs docs: Fix private doc links and enable CI test (#3743) 2022-02-02 21:47:29 +00:00
bevy_ecs_compile_fail_tests Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_gilrs Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_gltf Update gltf requirement from 0.16.0 to 1.0.0 (#3826) 2022-02-02 00:25:39 +00:00
bevy_input Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_internal Enable the doc_markdown clippy lint (#3457) 2022-01-09 23:20:13 +00:00
bevy_log Add crate level docs to bevy_log and enable #![warn(missing_docs)] (#3520) 2022-01-23 18:00:43 +00:00
bevy_macro_utils Don't panic in macro shape validation (#3647) 2022-01-15 22:14:43 +00:00
bevy_math Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_pbr bevy_pbr: Do not panic when more than 256 point lights are added the scene (#3697) 2022-01-17 22:22:15 +00:00
bevy_reflect document more of bevy_reflect (#3655) 2022-01-14 19:09:44 +00:00
bevy_render bevy_render: Only auto-disable mappable primary buffers for discrete GPUs (#3803) 2022-01-31 01:22:17 +00:00
bevy_scene Increment last event count on next instead of iter (#2382) 2022-02-02 02:29:33 +00:00
bevy_sprite Add the Inside version to the Collision enum (#2489) 2022-02-01 22:40:25 +00:00
bevy_tasks Document bevy_tasks and enable #![warn(missing_docs)] (#3509) 2022-01-16 04:53:22 +00:00
bevy_text Update docstrings for text_system and text2d_system (#3732) 2022-01-20 19:32:16 +00:00
bevy_transform Added docs for bevy_transform (#3516) 2022-01-14 18:47:48 +00:00
bevy_ui Update docstrings for text_system and text2d_system (#3732) 2022-01-20 19:32:16 +00:00
bevy_utils Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_window Enable the doc_markdown clippy lint (#3457) 2022-01-09 23:20:13 +00:00
bevy_winit do not set cursor grab on window creation if not asked for (#3617) 2022-01-15 20:29:58 +00:00