rust-psp icon indicating copy to clipboard operation
rust-psp copied to clipboard

Set up intra-doc links

Open sajattack opened this issue 4 years ago • 2 comments

Intra-doc links just hit stable rust. This allows us to make links in the docs, which would be very helpful for doc comments like this one:

/// Wait until display list has finished executing
///
/// # Parameters
///
/// - `mode`: What to wait for, one of `GuSyncMode`
/// - `behavior`: How to sync, one of `GuSyncBehavior`
///

If someone out there wants an easy way to get started contributing to rust-psp, this is it.

More info: https://blog.rust-lang.org/2020/11/19/Rust-1.48.html#easier-linking-in-rustdoc https://doc.rust-lang.org/stable/rustdoc/linking-to-items-by-name.html

sajattack avatar Nov 19 '20 21:11 sajattack

I think the crate needs more documentation in general. For example psp::sys::AudioInputParams has six variables, but only one of them has been named

DuckEater54 avatar Feb 10 '22 14:02 DuckEater54

I think the crate needs more documentation in general. For example psp::sys::AudioInputParams has six variables, but only one of them has been named

The docs were pulled in through some bindgen hacks from the C PSPSDK. It's also tricky to document everything because we literally don't know what all the functions do. It's OS calls to Sony functions that haven't been fully reverse engineered.

sajattack avatar Feb 10 '22 19:02 sajattack