Skip to content

Commit 16cee9b

Browse files
doccomment drops outdated ref to index.html generation
and adds line on how to do javadoc generation with third-party tools. closes #796
1 parent 01d06cf commit 16cee9b

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

content/api_en/include/doccomment.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ line(50, 0, 50, 100);
2222
</example>
2323

2424
<description><![CDATA[
25-
Explanatory notes embedded within the code and written to the "index.html" file created when the code is exported. Doc comments (documentation comments) are used for sharing a description of your sketch when the program is exported. Export the code by hitting the "Export" button on the Toolbar.
25+
Explanatory notes embedded within the code. Doc comments (documentation comments) are used to describe and document your sketch, classes, and methods. Comments are ignored by the compiler.
26+
<br><br>
27+
Doc comments may be converted into browseable documentation using external editors and tools such as the command line javadoc, doc generators such as Doxygen, or IDEs such as Eclipse, Netbeans, or IntelliJ IDEA.
2628
]]></description>
2729

2830
<syntax>

content/api_en/include/multilinecomment.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ line(50, 0, 50, 100);
2222
</example>
2323

2424
<description><![CDATA[
25-
Explanatory notes embedded within the code. Comments are used to remind yourself and to inform others about the function of your program. Multiline comments are used for large text descriptions of code or to comment out chunks of code while debugging applications. Comments are ignored by the compiler
25+
Explanatory notes embedded within the code. Comments are used to remind yourself and to inform others about the function of your program. Multiline comments are used for large text descriptions of code or to comment out chunks of code while debugging applications. Comments are ignored by the compiler.
2626
]]></description>
2727

2828
<syntax>

0 commit comments

Comments
 (0)