hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Konstantin Boudnik (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HADOOP-6205) Project java code has a significant number of declaration javadoc warnings and errors
Date Wed, 26 Aug 2009 04:39:59 GMT

    [ https://issues.apache.org/jira/browse/HADOOP-6205?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12747771#action_12747771
] 

Konstantin Boudnik commented on HADOOP-6205:
--------------------------------------------

Corrent list of JavaDoc errors for the project Common
{noformat}
Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference	FileMetadata.java
Common/src/java/org/apache/hadoop/fs/s3native	line 23
Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference	PartialListing.java
Common/src/java/org/apache/hadoop/fs/s3native	line 24
Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference	PartialListing.java
Common/src/java/org/apache/hadoop/fs/s3native	line 25
Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference	PartialListing.java
Common/src/java/org/apache/hadoop/fs/s3native	line 32
Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference	ConnectionHeader.java
Common/src/java/org/apache/hadoop/ipc	line 44
Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference	InMemoryNativeFileSystemStore.java
Common/src/test/core/org/apache/hadoop/fs/s3native	line 45
Javadoc: 'public' visibility for malformed doc comments hides this 'private' reference	MetricsTimeVaryingInt.java
Common/src/java/org/apache/hadoop/metrics/util	line 98
Javadoc: 'public' visibility for malformed doc comments hides this 'private' reference	MetricsTimeVaryingLong.java
Common/src/java/org/apache/hadoop/metrics/util	line 94
Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference	FileSystemContractBaseTest.java
Common/src/test/core/org/apache/hadoop/fs	line 41
Javadoc: DataInput cannot be resolved to a type	VersionMismatchException.java	Common/src/java/org/apache/hadoop/io
line 23
Javadoc: Exception IOException is not declared	LocalDirAllocator.java	Common/src/java/org/apache/hadoop/fs
line 177
Javadoc: Exception IOException is not declared	LineReader.java	Common/src/java/org/apache/hadoop/util
line 47
Javadoc: Exception IOException is not declared	LineReader.java	Common/src/java/org/apache/hadoop/util
line 58
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 153
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 154
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 286
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 287
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 303
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 304
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 305
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 336
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 553
Javadoc: Invalid param tag name	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 554
Javadoc: Invalid param tag name	MapFile.java	Common/src/java/org/apache/hadoop/io	line 444
Javadoc: Invalid param tag name	MapFile.java	Common/src/java/org/apache/hadoop/io	line 569
Javadoc: Invalid param tag name	SerializationTestUtil.java	Common/src/test/core/org/apache/hadoop/io/serializer
line 32
Javadoc: Invalid parameters declaration	CreateFlag.java	Common/src/java/org/apache/hadoop/fs
line 25
Javadoc: Invalid tag	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 155
Javadoc: Invalid tag	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 288
Javadoc: Invalid tag	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 306
Javadoc: Invalid tag	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 337
Javadoc: Invalid tag	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 946
Javadoc: Invalid tag	FsShell.java	Common/src/java/org/apache/hadoop/fs	line 1031
Javadoc: LocalDirAllocator.SIZE_UNKNOWN cannot be resolved to a type	LocalDirAllocator.java
Common/src/java/org/apache/hadoop/fs	line 352
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 63
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 77
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 88
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 99
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 110
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 128
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 140
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 152
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 164
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 176
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 188
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 200
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 212
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 224
Javadoc: MetricsException cannot be resolved to a type	MetricsRecordImpl.java	Common/src/java/org/apache/hadoop/metrics/spi
line 236
Javadoc: NetUtils cannot be resolved or is not a field	NetUtils.java	Common/src/java/org/apache/hadoop/net
line 248
Javadoc: NetUtils cannot be resolved or is not a field	NetUtils.java	Common/src/java/org/apache/hadoop/net
line 270
Javadoc: NetUtils cannot be resolved or is not a field	NetUtils.java	Common/src/java/org/apache/hadoop/net
line 299
Javadoc: NetUtils cannot be resolved or is not a field	NetUtils.java	Common/src/java/org/apache/hadoop/net
line 321
Javadoc: Unexpected tag	NetUtils.java	Common/src/java/org/apache/hadoop/net	line 415
Javadoc: Unexpected tag	TestLocalDirAllocator.java	Common/src/test/core/org/apache/hadoop/fs
line 182
{noformat}

> Project java code has a significant number of declaration javadoc warnings and errors
> -------------------------------------------------------------------------------------
>
>                 Key: HADOOP-6205
>                 URL: https://issues.apache.org/jira/browse/HADOOP-6205
>             Project: Hadoop Common
>          Issue Type: Improvement
>            Reporter: Konstantin Boudnik
>            Assignee: Konstantin Boudnik
>         Attachments: Eclipse-JavaDoc-errors.png
>
>
> The issue here is that code inspections (say by IntelliJ IDEA) show that a number of
classes have javadoc problems in declarations. Some of those are minor, e.g. missing @return,
@param, @throws tags.
> Some of them are more severe, e.g. using non-existing parameter names in a method javadoc
(see HDFS' BlockManager.removeFromInvalidates(..) for an example)
> I'd like to add more sophisticated code analysis to be able to fix at least javadoc declaration
errors in order to produce better code quality.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message