rust-mobile / ndk

Rust bindings to the Android NDK
Apache License 2.0
1.11k stars 110 forks source link

Drop `get_` prefix from `fn`s #437

Closed MarijnS95 closed 11 months ago

MarijnS95 commented 11 months ago

According to Rust's C-GETTER convention function names should not have a get_ prefix, and we maintain this standard in some but not all parts of the ndk. Consistenize that by dropping it everywhere, and add doc(alias)es to at least these functions (as I have been doing to new API wrappers added over the past few months too) to make it easier for users to find by the original NDK C symbol name.

In addition the audio module received some extra doc cleanup to get rid of redundant Available since API level xx. doc-comments (these are already provided via features and doc_cfg) as well as vague statements about integer return values when the return type has been translated to a Return<()>.