-
Notifications
You must be signed in to change notification settings - Fork 17
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
Improve docs #64
Merged
Merged
Improve docs #64
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
be42c73
Remove ``--no-doc-comments`` from ``bindgen.sh``
Techie-Pi 87b222a
Apply simple ``rustdoc`` suggestions
Techie-Pi 1e8c6cc
Fix issues with ``Fs`` docs
Techie-Pi d4db25c
Add docstring to rustdoc conversion
Techie-Pi 5446f97
Apply sugggestions
Techie-Pi 1eca556
Apply suggestions (II)
Techie-Pi File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
use std::{env, fs, io}; | ||
Techie-Pi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
use std::path::Path; | ||
|
||
fn main() -> io::Result<()> { | ||
let args: Vec<String> = env::args().collect(); | ||
|
||
let bindings_path = Path::new(args.get(1).expect("bindings.rs not provided in the args")); | ||
let bindings_string: String = fs::read_to_string(bindings_path)?; | ||
|
||
let parsed = bindings_string | ||
.lines() | ||
.map(|v| { | ||
// Only modify lines with the following structure: `` #[doc ... ] `` | ||
if v.trim_start().starts_with("#[doc") && v.trim_end().ends_with("]") { | ||
v | ||
.replace("@brief", "") | ||
// Example: ``@param offset Offset of the RomFS...`` -> ``- offset Offset of the RomFS...`` | ||
// Will improve in the future | ||
.replace("@param", "* ") | ||
.replace("@ref", "") | ||
.replace("@note", "") | ||
.replace("@return", "") | ||
.replace("@sa", "") | ||
.replace("< ", "") | ||
// Remove things like ``@param[out]`` | ||
.replace("[out]", "") | ||
.replace("[in]", "") | ||
// Trim start of the Rustdoc: ``...= " ...`` -> ``...= "...`` | ||
.replace("= \" ", "= \"") | ||
// Double pass because _most_ annotations are at the start | ||
.replace("= \" ", "= \"") | ||
} else { | ||
String::from(v) | ||
} | ||
}) | ||
.map(|v| { | ||
// End-lines of bindings.rs are CRLF | ||
v + "\r\n" | ||
Techie-Pi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
}) | ||
.collect::<String>(); | ||
|
||
let old_bindings_path = bindings_path.to_str().unwrap().to_owned() + ".old"; | ||
|
||
// If something fails, the original bindings are available at ``bindings.rs.old`` | ||
fs::rename(bindings_path, &old_bindings_path)?; | ||
fs::write(bindings_path, parsed)?; | ||
fs::remove_file(&old_bindings_path)?; | ||
|
||
Ok(()) | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Related (fyi): rust-lang/rust-bindgen#955
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ohh, I didn't see that until now! Thanks, I'll check it out!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing's implemented there, but someone else did have the idea to open an issue at least.