Skip to content

Commit

Permalink
Merge pull request #140 from JonasT/patch-1
Browse files Browse the repository at this point in the history
Being more direct on how tags look like when introducing them first
  • Loading branch information
stevedonovan committed Dec 31, 2013
2 parents 21eff88 + a870f91 commit b3f6fc2
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/doc.md
Expand Up @@ -66,8 +66,8 @@ All doc comments start with a summary sentence, that ends with a period or a que
An optional description may follow. Normally the summary sentence will appear in the module
contents.

After this descriptive text, there will typically be _tags_. These follow the convention
established by Javadoc and widely used in tools for other languages.
After this descriptive text, there will typically be _tags_ which are introduced with an @.
These follow the convention established by Javadoc and widely used in tools for other languages.

--- Some doc comment
-- @tag1 parameters for first tag
Expand Down

0 comments on commit b3f6fc2

Please sign in to comment.