Add missing docs for the vm module #1021
Merged
Conversation
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
wks
reviewed
Nov 13, 2023
src/vm/object_model.rs
Outdated
| pub struct $spec_name(MetadataSpec); | ||
| impl $spec_name { | ||
| #[doc="The number of bits (in log2) that are needed for the spec."] |
There was a problem hiding this comment.
Since /// xxxx is a syntax sugar for #[doc="xxxx"] at the language level, we can simply use /// in macro expansion, too. You can verify whether it produces documentation by executing cargo doc.
See: https://doc.rust-lang.org/reference/comments.html#doc-comments
Suggested change
| #[doc="The number of bits (in log2) that are needed for the spec."] | |
| /// The number of bits (in log2) that are needed for the spec. |
There was a problem hiding this comment.
Yeah. It works fine. I have changed most #[doc] to ///.
k-sareen
reviewed
Nov 13, 2023
k-sareen
reviewed
Nov 13, 2023
wks
requested changes
Nov 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR is a step towards #309.
HeaderMetadata.bit_offset(related discussion: https://mmtk.zulipchat.com/#narrow/stream/315620-Porting/topic/ScalaNative.2FMMTK/near/398587245).define_vm_metadata_spec!to allow adding docs for the generated types.vmmodule.Please feel free to make edits to the PR if there is any issue.