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.
Parses the mupdf docs and converts them into a more docs.rs friendly format. It links other types and functions and puts some parameter names in markdown inline code apostrophes. It also escapes
<
,>
,[
and]
as docs.rs will interpret them as HTML or links otherwise, causing the<path>
tag to disappear as in the pink highlighted example below.It also splits at every linebreak, which sometimes looks a bit unnecessary, but cases like the last example from the table below are otherwise unreadable.
Because of the very different styles of comments across the mupdf codebase some weird formatting issues might happen with this change, but I've looked for these cases and haven't found any yet.
Here are some comparisons: