Aire-One
/
LDoc2tl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #140 from JonasT/patch-1 

Being more direct on how tags look like when introducing them first
This commit is contained in:
Steve J Donovan 2013-12-31 01:02:41 -08:00
parent 21eff88c05 a870f91e59
commit b3f6fc2762
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/doc.md
View File

@ -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 An optional description may follow. Normally the summary sentence will appear in the module
contents. contents.
After this descriptive text, there will typically be _tags_. These follow the convention After this descriptive text, there will typically be _tags_ which are introduced with an @.
established by Javadoc and widely used in tools for other languages. These follow the convention established by Javadoc and widely used in tools for other languages.
--- Some doc comment --- Some doc comment
-- @tag1 parameters for first tag -- @tag1 parameters for first tag