diff --git a/doc/doc.md b/doc/doc.md index 2f0be13..ee1ec23 100644 --- a/doc/doc.md +++ b/doc/doc.md @@ -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