Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up intra-doc links #97

Open
sajattack opened this issue Nov 19, 2020 · 2 comments
Open

Set up intra-doc links #97

sajattack opened this issue Nov 19, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@sajattack
Copy link
Collaborator

sajattack commented Nov 19, 2020

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 sajattack added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 19, 2020
@DuckEater54
Copy link

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

@sajattack
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants