Skip to content
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

Add support for triple ///, //! and /*! style comments + basic Rust support #215

Closed
wants to merge 4 commits into from

Conversation

Seldaek
Copy link
Contributor

@Seldaek Seldaek commented Aug 26, 2013

This adds support for:

  • rust-style /// triple slash docblocks (also fixes Triple slash doc style #214).
  • rust //! and /*! comments for documenting modules.
  • adds a very dumb JsdocsRust class that just suppresses all docblock generation because we don't have any of that in rust.

I hope it's all reasonable changes :)

@@ -5,7 +5,7 @@
{ "key": "setting.auto_indent", "operator": "equal", "operand": true, "match_all": true },
{ "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
{ "key": "auto_complete_visible", "operator": "equal", "operand": false, "match_all": true },
{ "key": "preceding_text", "operator": "regex_contains", "operand": "^\\s*(\\/\\*|###)\\*\\s*$", "match_all": true }
{ "key": "preceding_text", "operator": "regex_contains", "operand": "^\\s*(\\/\\*|###)[\\*!]\\s*$", "match_all": true }
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor point here, but inside of a character class block ([square brackets]), the asterisk has no special meaning, so it doesn't need escaping. "^\\s(\\/\\*|###)[*!]\\s*$"

@spadgos
Copy link
Owner

spadgos commented Sep 8, 2013

Sorry for taking so long to look at this. It looks pretty good, but would you be able to target the PR to the develop branch? master is the 'stable' branch which goes out to everyone's editors.

@Seldaek
Copy link
Contributor Author

Seldaek commented Sep 8, 2013

Alright, opened #223 against develop. Fixed the greedy escaping of wildcards too. Closing this one.

@Seldaek Seldaek closed this Sep 8, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Triple slash doc style
3 participants