Convert roxygen comments to documentation #305
Merged
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.
Close #304
This PR imports
roxygen2
and implementsconvert_comment_to_documentation
whereroxygen2::parse_text()
is tried to parse comments as roxygen tags to provide structured documentation.The information presented in hover contains all parsed roxygen tags presented in markdown format while only description is presented in completion resolve of symbol and function arguments and function signature, which is consistent with currently presented information provided by these providers.
Following is a screencast: