Skip to content

Commit

Permalink
Add #223 to changelogs
Browse files Browse the repository at this point in the history
  • Loading branch information
KronicDeth committed Dec 25, 2015
1 parent 42488c9 commit 05540b1
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Expand Up @@ -9,6 +9,14 @@
* Kernel.SpecialForms Macros
* [#219](https://github.com/KronicDeth/intellij-elixir/pull/219) - Test against Elixir v1.1.1 - [KronicDeth](https://github.com/KronicDeth)
* [#221](https://github.com/KronicDeth/intellij-elixir/pull/221) - Highlight `after`, `catch`, `do`, `else`, `end, `fn`, and `rescue` as keywords - [KronicDeth](https://github.com/KronicDeth)
* [#223](https://github.com/KronicDeth/intellij-elixir/pull/223) - Annotate Module Attributes - [KronicDeth](https://github.com/KronicDeth)
* Documentation module attributes (`@doc`, `@moduledoc`, and `@typedoc`) are annotated as "Documentation Module Attributes" while all other module attributes are annotated as "Module Attributes".
* The string or heredoc argument to a documentation module attribute (`@doc`, `@moduledoc`, and `@typedoc` is annotated as "Documentation Text"
* Function names passed to `@callback`, `@macrocallback` or `@specification` are annotated as "Specification".
* Variables/calls in the parameters and return of `@callback`, `@macrocallback`, `@specification` are annotated as "Type".
* Parameters of `@opaque`, `@type`, `@typep` names are annotated as "Type Parameter"
* Keyword keys from the `when` clause of `@callback`, `@macrocallback` or `@spec` definitions and their usage are annotated as "Type Parameters"
* `@doc false`, `@moduledoc false`, and `@typedoc false` will annotate the `false` with a weak warning: "Will make documented invisible to the documentation extraction tools like ExDoc.".

* Bug Fixes
* [#206](https://github.com/KronicDeth/intellij-elixir/pull/206) - Change "edition" to "addition" in README. - [folz](https://github.com/folz)
Expand Down
35 changes: 35 additions & 0 deletions src/META-INF/plugin.xml
Expand Up @@ -27,6 +27,41 @@
Highlight <code>after</code>, <code>catch</code>, <code>do</code>, <code>else</code>, <code>end,
</code>fn<code>, and </code>rescue` as keywords.
</li>
<li>
<p>Annotate Module Attributes</p>
<ul>
<li>
Documentation module attributes (<code>@doc</code>, <code>@moduledoc</code>, and
<code>@typedoc</code>) are annotated as "Documentation Module Attributes" while all other module
attributes are annotated as "Module Attributes".
</li>
<li>
The string or heredoc argument to a documentation module attribute (<code>@doc</code>,
<code>@moduledoc</code>, and <code>@typedoc</code> is annotated as "Documentation Text"
</li>
<li>
Function names passed to <code>@callback</code>, <code>@macrocallback</code> or
<code>@specification</code> are annotated as "Specification".
</li>
<li>
Variables/calls in the parameters and return of <code>@callback</code>, <code>@macrocallback</code>,
<code>@specification</code> are annotated as "Type".
</li>
<li>
Parameters of <code>@opaque</code>, <code>@type</code>, <code>@typep</code> names are annotated as
"Type Parameter"
</li>
<li>
Keyword keys from the <code>when</code> clause of <code>@callback</code>, <code>@macrocallback</code>
or <code>@spec</code> definitions and their usage are annotated as "Type Parameters"
</li>
<li>
<code>@doc false</code>, <code>@moduledoc false</code>, and <code>@typedoc false</code> will annotate
the <code>false</code> with a weak warning: "Will make documented invisible to the documentation
extraction tools like ExDoc.".
</li>
</ul>
</li>
</ul>
</li>
<li>
Expand Down

0 comments on commit 05540b1

Please sign in to comment.