Annotate module attributes #223
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
Use `CodeInsightColors.ANNOTATION_NAME_ATTRIBUTES` to match color used for "ERL_ATTRIBUTE" in intellij-erlang.
The heredoc or line after `@doc`, `@moduledoc`, or `@typedoc` will be highlighted as Documentation Text, which defaults to DOC_COMMENT_TAG_VALUE.
The `@callback` will be highlighted as a "Module Attributes" while the name of the function itself will be highlighted as "Callbacks".
In @type, @TypeP, and @opaque, arguments to the type name are Type Parameters that can be filled in later when the type is used. The type parameters appear in the definition of the type. For @SPEC and @callback, since the argument slots are already used for just the types of the parameters, the type parameters are supplied as keyword keys in a when clause.
KronicDeth
added a commit
that referenced
this pull request
Dec 26, 2015
KronicDeth
added a commit
that referenced
this pull request
Dec 26, 2015
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.
Resolves #132
Changelog
@doc,@moduledoc, and@typedoc) are annotated as "Documentation Module Attributes" while all other module attributes are annotated as "Module Attributes".@doc,@moduledoc, and@typedocis annotated as "Documentation Text"@callback,@macrocallbackor@specificationare annotated as "Specification".@callback,@macrocallback,@specificationare annotated as "Type".@opaque,@type,@typepnames are annotated as "Type Parameter"whenclause of@callback,@macrocallbackor@specdefinitions and their usage are annotated as "Type Parameters"@doc false,@moduledoc false, and@typedoc falsewill annotate thefalsewith a weak warning: "Will make documented invisible to the documentation extraction tools like ExDoc.".