search

kieker-monitoring / kieker

Kieker's main repository
Apache License 2.0
70 stars 41 forks source link

[KIEKER-919] Javadoc warnings #713

Open rju opened 1 week ago

rju commented 1 week ago

JIRA Issue: https://kieker-monitoring.atlassian.net/browse/KIEKER-919 Original Reporter: Jan Waller (JIRA username)

We should fix all remaining javadoc warnings:

currently:

  [javadoc] C:\Users\jwa\Projects\Kieker\src-gen\analysis\kieker\analysis\model\analysisMetaModel\impl\MAnalysisMetaModelPackage.java:180: warning - Tag @link: can't find eINSTANCE in MIAnalysisMetaModelPackage
  [javadoc] C:\Users\jwa\Projects\Kieker\src\analysis\kieker\analysis\AnalysisController.java:787: warning - @inheritDoc used but registerReader(AbstractReaderPlugin) does not override or implement any method.
  [javadoc] C:\Users\jwa\Projects\Kieker\src\analysis\kieker\analysis\AnalysisController.java:810: warning - @inheritDoc used but registerFilter(AbstractFilterPlugin) does not override or implement any method.
  [javadoc] C:\Users\jwa\Projects\Kieker\src\analysis\kieker\analysis\AnalysisController.java:833: warning - @inheritDoc used but registerRepository(AbstractRepository) does not override or implement any method.
  [javadoc] C:\Users\jwa\Projects\Kieker\src\common\kieker\common\record\IMonitoringRecord.java:97: warning - Tag @link: can't find IMonitoringRecord.getValueTypes() in kieker.common.record.IMonitoringRecord.Factory
  [javadoc] C:\Users\jwa\Projects\Kieker\src\common\kieker\common\record\IMonitoringRecord.java:97: warning - Tag @link: can't find IMonitoringRecord.initFromArray(Object[] values) in kieker.common.record.IMonitoringRecord.Factory
  [javadoc] C:\Users\jwa\Projects\Kieker\src\common\kieker\common\record\controlflow\OperationExecutionRecord.java:98: warning - Tag @link: reference not found: kieker.common.util.ClassOperationSignaturePair#splitOperationSignatureStr(String)
  [javadoc] C:\Users\jwa\Projects\Kieker\src\tools\kieker\tools\traceAnalysis\filter\executionRecordTransformation\ExecutionRecordTransformationFilter.java:93: warning - @return tag cannot be used in method with void return type.

Checklist:

JIRA Comments:

557058:629db7ce-5cef-419f-82f8-3dcdebf76471 (JIRA username) added a comment on Tue, 19 Mar 2013 18:29:50

Solved in 90b323cf6680d8c77f36b95846e1700895033be3.

Only remaining warning is 

[javadoc] C:\HiWi\kieker working copy\src-gen\analysis\kieker\analysis\model\analysisMetaModel\impl\MAnalysisMetaModelPackage.java:180: warning - Tag @link: can't find eINSTANCE in MIAnalysisMetaModelPackage

This one can't be solved as the class is auto-generated.

Reopen if more warnings occur.

rju commented 3 days ago

author nils-christian -- Tue, 19 Mar 2013 18:29:50 +0100

Solved in 90b323cf6680d8c77f36b95846e1700895033be3.

Only remaining warning is 

[javadoc] C:\HiWi\kieker working copy\src-gen\analysis\kieker\analysis\model\analysisMetaModel\impl\MAnalysisMetaModelPackage.java:180: warning - Tag link: can't find eINSTANCE in MIAnalysisMetaModelPackage

This one can't be solved as the class is auto-generated.

Reopen if more warnings occur.