Javadoc Warnings under Java 8

[asfimport]

@milamberspace (Bug 57193):
Ref. http://mail-archives.apache.org/mod_mbox/jmeter-dev/201411.mbox/%3C545C9615.3060803%40kippdata.de%3E

Javadoc Warnings under Java 8:

/src/core/org/apache/jmeter/JMeter.java:274: warning: no @param for args
/src/core/org/apache/jmeter/JMeter.java:847: warning: no description for @param
/src/reports/org/apache/jmeter/JMeterReport.java:299: warning: no description for @param
/src/core/org/apache/jmeter/NewDriver.java:190: warning: no description for @param
/src/core/org/apache/jmeter/NewDriver.java:200: warning: no description for @throws
/src/core/org/apache/jmeter/util/BeanShellTestElement.java:137: warning: no description for @throws
/src/core/org/apache/jmeter/testelement/TestElement.java:79: warning: no @return
/src/core/org/apache/jmeter/testelement/TestElement.java:85: warning: no description for @param
/src/core/org/apache/jmeter/testelement/TestElement.java:102: warning: no @param for key
/src/core/org/apache/jmeter/testelement/TestElement.java:102: warning: no @return
/src/core/org/apache/jmeter/testelement/TestElement.java:126: warning: no @param for run
/src/core/org/apache/jmeter/testelement/TestElement.java:149: warning: no @param for property
/src/core/org/apache/jmeter/testelement/TestElement.java:155: warning: no @param for propName
/src/core/org/apache/jmeter/testelement/TestElement.java:155: warning: no @return
/src/core/org/apache/jmeter/testelement/TestElement.java:173: warning: no @param for traverser
/src/core/org/apache/jmeter/gui/Searchable.java:29: warning: no description for @throws
/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java:71: warning: no description for @param
/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java:81: warning: no description for @param
/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java:91: warning: no description for @param
/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java:101: warning: no description for @param
/src/components/org/apache/jmeter/assertions/HTMLAssertion.java:260: warning: no description for @param
/src/components/org/apache/jmeter/assertions/HTMLAssertion.java:273: warning: no description for @param
/src/components/org/apache/jmeter/assertions/HTMLAssertion.java:282: warning: no description for @param
/src/components/org/apache/jmeter/assertions/HTMLAssertion.java:298: warning: no description for @param
/src/components/org/apache/jmeter/assertions/HTMLAssertion.java:371: warning: no description for @param
/src/core/org/apache/jmeter/util/JSR223TestElement.java:135: warning: no description for @throws
/src/core/org/apache/jmeter/util/JSR223TestElement.java:136: warning: no description for @throws
/src/components/org/apache/jmeter/assertions/SizeAssertion.java:113: warning: no @return
/src/components/org/apache/jmeter/assertions/SizeAssertion.java:120: warning: no @param for operator
/src/components/org/apache/jmeter/assertions/SizeAssertion.java:130: warning: no @return
/src/components/org/apache/jmeter/assertions/XPathAssertion.java:159: warning: no description for @param
/src/components/org/apache/jmeter/assertions/XPathAssertion.java:168: warning: no description for @param
/src/components/org/apache/jmeter/assertions/XPathAssertion.java:177: warning: no description for @param
/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java:91: warning: no description for @param
/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java:110: warning: no description for @param
/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java:119: warning: no description for @param
/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java:120: warning: no description for @param
/src/core/org/apache/jmeter/gui/AbstractJMeterGuiComponent.java:96: warning: no @param for comment
/src/core/org/apache/jmeter/gui/AbstractJMeterGuiComponent.java:135: warning: no @return
/src/components/org/apache/jmeter/assertions/gui/HTMLAssertionGui.java:170: warning: no description for @param
/src/components/org/apache/jmeter/assertions/gui/HTMLAssertionGui.java:268: warning: no description for @param
/src/components/org/apache/jmeter/assertions/gui/HTMLAssertionGui.java:313: warning: no @param for e
/src/components/org/apache/jmeter/assertions/gui/SizeAssertionGui.java:155: warning: no @param for state
/src/components/org/apache/jmeter/assertions/gui/SizeAssertionGui.java:180: warning: no @return
/src/components/org/apache/jmeter/assertions/gui/XPathPanel.java:94: warning: no description for @param
/src/components/org/apache/jmeter/assertions/gui/XPathPanel.java:112: warning: no description for @param
/src/core/org/apache/jmeter/config/gui/RowDetailDialog.java:234: warning: no description for @param
/src/core/org/apache/jmeter/control/Controller.java:53: warning: no @param for listener
/src/components/org/apache/jmeter/control/CriticalSectionController.java:95: warning: no @param for name
/src/core/org/apache/jmeter/control/GenericController.java:210: warning: no description for @param
/src/core/org/apache/jmeter/control/GenericController.java:220: warning: no description for @param
/src/core/org/apache/jmeter/control/GenericController.java:222: warning: no description for @throws
/src/core/org/apache/jmeter/control/GenericController.java:238: warning: no description for @param
/src/core/org/apache/jmeter/control/GenericController.java:240: warning: no description for @throws
/src/core/org/apache/jmeter/control/GenericController.java:252: warning: no description for @throws
/src/core/org/apache/jmeter/control/GenericController.java:305: warning: no description for @param
/src/core/org/apache/jmeter/control/GenericController.java:306: warning: no description for @throws
/src/core/org/apache/jmeter/threads/TestCompilerHelper.java:42: warning: no description for @param
/src/components/org/apache/jmeter/control/CriticalSectionController.java:87: warning: no @param for name
/src/core/org/apache/jmeter/control/IfController.java:86: warning: no @param for condition
/src/core/org/apache/jmeter/control/IfController.java:93: warning: no @return
/src/core/org/apache/jmeter/control/IfController.java:78: warning: no @param for condition
/src/components/org/apache/jmeter/control/IncludeController.java:87: warning: no description for @param
/src/components/org/apache/jmeter/control/IncludeController.java:122: warning: no @return
/src/core/org/apache/jmeter/control/ReplaceableController.java:38: warning: no @return
/src/core/org/apache/jmeter/control/ReplaceableController.java:43: warning: no description for @param
/src/components/org/apache/jmeter/control/ModuleController.java:132: warning: no description for @param
/src/core/org/apache/jmeter/control/TransactionController.java:308: warning: no description for @param
/src/core/org/apache/jmeter/samplers/SampleListener.java:32: warning: no @param for e
/src/core/org/apache/jmeter/samplers/SampleListener.java:37: warning: no @param for e
/src/core/org/apache/jmeter/samplers/SampleListener.java:42: warning: no @param for e
/src/core/org/apache/jmeter/samplers/Sampler.java:36: warning: no @param for e
/src/core/org/apache/jmeter/samplers/Sampler.java:36: warning: no @return
/src/core/org/apache/jmeter/engine/TreeCloner.java:59: warning: no description for @param
/src/core/org/apache/jmeter/functions/Function.java:40: warning: no @param for previousResult
/src/core/org/apache/jmeter/functions/Function.java:40: warning: no @param for currentSampler
/src/core/org/apache/jmeter/functions/Function.java:40: warning: no @return
/src/core/org/apache/jmeter/functions/Function.java:40: warning: no @throws for org.apache.jmeter.functions.InvalidVariableException
/src/core/org/apache/jmeter/functions/Function.java:48: warning: no description for @param
/src/core/org/apache/jmeter/functions/Function.java:49: warning: no description for @throws
/src/core/org/apache/jmeter/functions/Function.java:57: warning: no @return
/src/core/org/apache/jmeter/functions/Function.java:69: warning: no @return
/src/core/org/apache/jmeter/engine/util/ValueTransformer.java:42: warning: no description for @param
/src/core/org/apache/jmeter/engine/util/ValueTransformer.java:50: warning: no description for @param
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:67: warning: no description for @param
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:68: warning: no description for @throws
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:85: warning: no description for @param
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:86: warning: no description for @throws
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:96: warning: no description for @param
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:97: warning: no description for @param
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:98: warning: no description for @throws
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:108: warning: no description for @param
/src/core/org/apache/jmeter/engine/util/ValueReplacer.java:109: warning: no description for @throws
/src/functions/org/apache/jmeter/functions/FileWrapper.java:181: warning: no description for @param
/src/core/org/apache/jmeter/gui/GuiPackage.java:676: warning: no description for @param
/src/core/org/apache/jmeter/gui/GuiPackage.java:761: warning: no description for @param
/src/core/org/apache/jmeter/gui/GuiPackage.java:779: warning: no description for @param
/src/core/org/apache/jmeter/gui/MainFrame.java:819: warning: no description for @param
/src/core/org/apache/jmeter/gui/MainFrame.java:820: warning: no description for @param
/src/reports/org/apache/jmeter/gui/ReportGuiPackage.java:603: warning: no description for @param

Version: Nightly
Severity: minor
OS: All

[asfimport]

@FSchumacher (migrated from Bugzilla):
There are also errors in the javadoc, when generated with java 8. I have a few patches to correct some of the errors. Should I reference this bug entry, when I commit them?

[asfimport]

@milamberspace (migrated from Bugzilla):
Created attachment javadoc_warning_errors.txt: full log of warnings/errors when javadoc v8 build the doc

[asfimport]

@milamberspace (migrated from Bugzilla):
Yes you could (for the follow). I've add the full log of warnings/errors when javadoc v8 build the doc.

[asfimport]

@FSchumacher (migrated from Bugzilla):
A few warnings remain in the reports package, but that package is doomed to be removed shortly, so with the following commits I will close this bug.

---

r1649796 | fschumacher | 2015-01-06 13:45:31 +0100 (Di, 06. Jan 2015) | 4 Zeilen

#3474: Use inheritDoc instead of a simple see attribute. The pointed to method was missing a parameter, too.
Fix javadocs
#3474

---

r1649792 | pmouawad | 2015-01-06 13:26:27 +0100 (Di, 06. Jan 2015) | 3 Zeilen

#3474: Add param and return tags to javadoc
Fix javadocs
#3474

r1649779 | fschumacher | 2015-01-06 12:08:06 +0100 (Di, 06. Jan 2015) | 4 Zeilen

#3474: Since we are not generating javadoc for private classes,
we can not reference to them in javadoc
#3474

---

r1649775 | fschumacher | 2015-01-06 12:02:22 +0100 (Di, 06. Jan 2015) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1649531 | fschumacher | 2015-01-05 15:18:13 +0100 (Mo, 05. Jan 2015) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1649516 | fschumacher | 2015-01-05 13:33:41 +0100 (Mo, 05. Jan 2015) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1649423 | fschumacher | 2015-01-04 22:13:50 +0100 (So, 04. Jan 2015) | 4 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1649318 | fschumacher | 2015-01-04 13:14:41 +0100 (So, 04. Jan 2015) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1649126 | fschumacher | 2015-01-02 22:13:05 +0100 (Fr, 02. Jan 2015) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1649078 | fschumacher | 2015-01-02 18:06:11 +0100 (Fr, 02. Jan 2015) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1648732 | fschumacher | 2014-12-31 18:04:58 +0100 (Mi, 31. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1648709 | fschumacher | 2014-12-31 15:48:21 +0100 (Mi, 31. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1648239 | fschumacher | 2014-12-28 19:26:25 +0100 (So, 28. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1648229 | fschumacher | 2014-12-28 18:31:20 +0100 (So, 28. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1648193 | fschumacher | 2014-12-28 13:47:46 +0100 (So, 28. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1647786 | fschumacher | 2014-12-24 14:58:11 +0100 (Mi, 24. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1647589 | fschumacher | 2014-12-23 16:09:47 +0100 (Di, 23. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1647378 | fschumacher | 2014-12-22 20:03:37 +0100 (Mo, 22. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1647347 | fschumacher | 2014-12-22 17:25:38 +0100 (Mo, 22. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1647215 | fschumacher | 2014-12-21 22:26:14 +0100 (So, 21. Dez 2014) | 4 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1647209 | fschumacher | 2014-12-21 21:53:23 +0100 (So, 21. Dez 2014) | 5 Zeilen

#3474: Add param and return tags to javadoc
Don't add import just for javadoc.

#3474

---

r1647188 | fschumacher | 2014-12-21 19:58:47 +0100 (So, 21. Dez 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1642447 | fschumacher | 2014-11-29 17:19:51 +0100 (Sa, 29. Nov 2014) | 4 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1642416 | fschumacher | 2014-11-29 12:04:14 +0100 (Sa, 29. Nov 2014) | 4 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1642225 | fschumacher | 2014-11-27 20:53:36 +0100 (Do, 27. Nov 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1642223 | fschumacher | 2014-11-27 20:52:11 +0100 (Do, 27. Nov 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1641439 | fschumacher | 2014-11-24 19:36:36 +0100 (Mo, 24. Nov 2014) | 4 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1641242 | fschumacher | 2014-11-23 20:04:35 +0100 (So, 23. Nov 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1641171 | fschumacher | 2014-11-23 11:33:16 +0100 (So, 23. Nov 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1641063 | fschumacher | 2014-11-22 14:45:15 +0100 (Sa, 22. Nov 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1640423 | fschumacher | 2014-11-18 21:49:24 +0100 (Di, 18. Nov 2014) | 3 Zeilen

#3474: Add param and return tags to javadoc
#3474

---

r1639793 | fschumacher | 2014-11-14 22:38:50 +0100 (Fr, 14. Nov 2014) | 4 Zeilen

#3474: Add description for param and return attributes in
javadoc.
#3474

---

r1639778 | fschumacher | 2014-11-14 21:30:33 +0100 (Fr, 14. Nov 2014) | 4 Zeilen

#3474: * Generics won't work in javadoc, so describe the type
textually. * add missing return and throws javadoc statements
#3474

---

r1639495 | fschumacher | 2014-11-13 20:34:07 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: A bit more description of the parameters in javadoc
#3474

---

r1639494 | fschumacher | 2014-11-13 20:32:13 +0100 (Do, 13. Nov 2014) | 4 Zeilen

#3474: Add javadoc @param, @return and @throws tags, or fill
them.
#3474

---

r1639491 | fschumacher | 2014-11-13 20:30:59 +0100 (Do, 13. Nov 2014) | 4 Zeilen

#3474: Generics can't be used inside of javadoc, so omit them
and describe it textually.
#3474

---

r1639490 | fschumacher | 2014-11-13 20:30:02 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Add description for @param and @throws in javadoc
#3474

---

r1639486 | fschumacher | 2014-11-13 20:28:42 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Correctly close ol tag in javadoc
#3474

---

r1639484 | fschumacher | 2014-11-13 20:27:58 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Escape &, < and > in javadoc
#3474

---

r1639483 | fschumacher | 2014-11-13 20:27:00 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Close code block correctly.
#3474

---

r1639482 | fschumacher | 2014-11-13 20:26:01 +0100 (Do, 13. Nov 2014) | 4 Zeilen

#3474: Escape &, < and >, as they are not allowed inside
javadoc
#3474

---

r1639481 | fschumacher | 2014-11-13 20:25:12 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Self-closing br element is not allowed in javadoc
#3474

---

r1639480 | fschumacher | 2014-11-13 20:24:20 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Correct dt/dd tags in javadoc
#3474

---

r1639476 | fschumacher | 2014-11-13 20:23:21 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Remove unexpected </p> tags in javadoc
#3474

---

r1639474 | fschumacher | 2014-11-13 20:22:00 +0100 (Do, 13. Nov 2014) | 4 Zeilen

#3474: Replace a few more &, < and > with html escaped version for
javadoc
#3474

---

r1639472 | fschumacher | 2014-11-13 20:20:36 +0100 (Do, 13. Nov 2014) | 4 Zeilen

#3474: Put <a...> on one line, as it will confuse javadoc
otherwise.
#3474

---

r1639469 | fschumacher | 2014-11-13 20:17:21 +0100 (Do, 13. Nov 2014) | 4 Zeilen

#3474: Escape entities like &, < and >, as they are not
allowed in javadocs. Place code tag around code-fragments in javadoc.
#3474

---

r1639464 | fschumacher | 2014-11-13 20:13:43 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Remove self-closing elements like <p/> or <br/>.
#3474

---

r1639463 | fschumacher | 2014-11-13 20:12:07 +0100 (Do, 13. Nov 2014) | 5 Zeilen

#3474: Place @see below the note and remove the break. If @see
is above the note, the note will not be shown in javadocs. Removes a
broken "br" tag
#3474

---

r1639462 | fschumacher | 2014-11-13 20:10:39 +0100 (Do, 13. Nov 2014) | 3 Zeilen

#3474: Use unordered list in javadoc instead of handcoded one. Removes wrong "br" tags
#3474

---

r1639461 | fschumacher | 2014-11-13 20:09:14 +0100 (Do, 13. Nov 2014) | 7 Zeilen

#3474: A few javadoc fixes

• Remove self-closing br-tags by replacing them with a
  unordered list
• Add links to URL in javadaocs
• Add a return description in javadocs
  Javadoc Warnings under Java 8 #3474

---

r1639424 | fschumacher | 2014-11-13 19:11:02 +0100 (Do, 13. Nov 2014) | 4 Zeilen

#3474: CyclicBarrier#await will not throw TimeOutException, so
don't say so in javadocs.
#3474