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

Being more direct on how tags look like when introducing them first

This commit is contained in:
JonasT 2013-12-31 08:07:41 +01:00
parent 2db76970ab
commit a870f91e59
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

@ -59,8 +59,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.
--- foo explodes text.
-- It is a specialized splitting operation on a string.