Return-Path: Delivered-To: apmail-hadoop-common-issues-archive@minotaur.apache.org Received: (qmail 91208 invoked from network); 26 Aug 2009 04:21:58 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 26 Aug 2009 04:21:58 -0000 Received: (qmail 34398 invoked by uid 500); 26 Aug 2009 04:22:22 -0000 Delivered-To: apmail-hadoop-common-issues-archive@hadoop.apache.org Received: (qmail 34330 invoked by uid 500); 26 Aug 2009 04:22:22 -0000 Mailing-List: contact common-issues-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: common-issues@hadoop.apache.org Delivered-To: mailing list common-issues@hadoop.apache.org Received: (qmail 34308 invoked by uid 99); 26 Aug 2009 04:22:21 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 26 Aug 2009 04:22:21 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.140] (HELO brutus.apache.org) (140.211.11.140) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 26 Aug 2009 04:22:19 +0000 Received: from brutus (localhost [127.0.0.1]) by brutus.apache.org (Postfix) with ESMTP id 4DF40234C04C for ; Tue, 25 Aug 2009 21:21:59 -0700 (PDT) Message-ID: <1727594795.1251260519304.JavaMail.jira@brutus> Date: Tue, 25 Aug 2009 21:21:59 -0700 (PDT) From: "Konstantin Boudnik (JIRA)" To: common-issues@hadoop.apache.org Subject: [jira] Commented: (HADOOP-6205) Project java code has a significant number of declaration javadoc warnings and errors In-Reply-To: <2108675829.1250797574846.JavaMail.jira@brutus> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 X-Virus-Checked: Checked by ClamAV on apache.org [ https://issues.apache.org/jira/browse/HADOOP-6205?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12747761#action_12747761 ] Konstantin Boudnik commented on HADOOP-6205: -------------------------------------------- List of JavaDoc errors for Common project {noformat} Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference CapacityTaskScheduler.java MR/src/contrib/capacity-scheduler/src/java/org/apache/hadoop/mapred line 40 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobInitializationPoller.java MR/src/contrib/capacity-scheduler/src/java/org/apache/hadoop/mapred line 36 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobQueuesManager.java MR/src/contrib/capacity-scheduler/src/java/org/apache/hadoop/mapred line 35 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestCapacitySchedulerWithJobTracker.java MR/src/contrib/capacity-scheduler/src/test/org/apache/hadoop/mapred line 32 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestCapacitySchedulerWithJobTracker.java MR/src/contrib/capacity-scheduler/src/test/org/apache/hadoop/mapred line 64 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference DynamicPriorityScheduler.java MR/src/contrib/dynamic-scheduler/src/java/org/apache/hadoop/mapred line 43 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference DynamicPriorityServlet.java MR/src/contrib/dynamic-scheduler/src/java/org/apache/hadoop/mapred line 42 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference PriorityScheduler.java MR/src/contrib/dynamic-scheduler/src/java/org/apache/hadoop/mapred line 47 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference FairScheduler.java MR/src/contrib/fairscheduler/src/java/org/apache/hadoop/mapred line 41 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference FairSchedulerEventLog.java MR/src/contrib/fairscheduler/src/java/org/apache/hadoop/mapred line 49 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference LoadManager.java MR/src/contrib/fairscheduler/src/java/org/apache/hadoop/mapred line 28 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskSelector.java MR/src/contrib/fairscheduler/src/java/org/apache/hadoop/mapred line 29 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestTestDriver.java MR/src/contrib/mrunit/src/test/org/apache/hadoop/mrunit line 35 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference CleanupQueue.java MR/src/java/org/apache/hadoop/mapred line 42 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference EagerTaskInitializationListener.java MR/src/java/org/apache/hadoop/mapred line 34 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference EagerTaskInitializationListener.java MR/src/java/org/apache/hadoop/mapred line 35 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference IFileInputStream.java MR/src/java/org/apache/hadoop/mapred line 30 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference InterTrackerProtocol.java MR/src/java/org/apache/hadoop/mapred line 33 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference InterTrackerProtocol.java MR/src/java/org/apache/hadoop/mapred line 76 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference InterTrackerProtocol.java MR/src/java/org/apache/hadoop/mapred line 93 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobChangeEvent.java MR/src/java/org/apache/hadoop/mapred line 21 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobInProgressListener.java MR/src/java/org/apache/hadoop/mapred line 43 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobQueueJobInProgressListener.java MR/src/java/org/apache/hadoop/mapred line 29 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobQueueTaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 31 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobStatusChangeEvent.java MR/src/java/org/apache/hadoop/mapred line 21 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobTracker.java MR/src/java/org/apache/hadoop/mapred line 2832 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference JobTracker.java MR/src/java/org/apache/hadoop/mapred line 3940 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference LimitTasksPerJobTaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 32 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference LinuxTaskController.java MR/src/java/org/apache/hadoop/mapred line 37 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference LinuxTaskController.java MR/src/java/org/apache/hadoop/mapred line 41 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference LinuxTaskController.java MR/src/java/org/apache/hadoop/mapred line 48 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference LocalJobRunner.java MR/src/java/org/apache/hadoop/mapred line 466 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference QueueManager.java MR/src/java/org/apache/hadoop/mapred line 117 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference QueueManager.java MR/src/java/org/apache/hadoop/mapred line 137 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference QueueManager.java MR/src/java/org/apache/hadoop/mapred line 145 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TIPStatus.java MR/src/java/org/apache/hadoop/mapred line 20 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 32 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 33 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 35 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 38 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 40 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 41 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 47 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 48 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 49 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 54 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 55 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 56 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 61 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 62 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 64 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerStatus.java MR/src/java/org/apache/hadoop/mapred line 256 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskTrackerStatus.java MR/src/java/org/apache/hadoop/mapred line 258 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TaskUmbilicalProtocol.java MR/src/java/org/apache/hadoop/mapred line 146 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference PipesNonJavaInputFormat.java MR/src/java/org/apache/hadoop/mapred/pipes line 38 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference MarkableIterator.java MR/src/java/org/apache/hadoop/mapreduce line 26 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestLocalizationWithLinuxTaskController.java MR/src/test/mapred/org/apache/hadoop/mapred line 39 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestLocalizationWithLinuxTaskController.java MR/src/test/mapred/org/apache/hadoop/mapred line 92 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestLocalizationWithLinuxTaskController.java MR/src/test/mapred/org/apache/hadoop/mapred line 167 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestRecoveryManager.java MR/src/test/mapred/org/apache/hadoop/mapred line 38 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestRecoveryManager.java MR/src/test/mapred/org/apache/hadoop/mapred line 39 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestRecoveryManager.java MR/src/test/mapred/org/apache/hadoop/mapred line 51 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestRecoveryManager.java MR/src/test/mapred/org/apache/hadoop/mapred line 146 Javadoc: 'public' visibility for malformed doc comments hides this 'default' reference TestTTMemoryReporting.java MR/src/test/mapred/org/apache/hadoop/mapred line 38 Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference Schedulable.java MR/src/contrib/fairscheduler/src/java/org/apache/hadoop/mapred line 102 Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference TestTestDriver.java MR/src/contrib/mrunit/src/test/org/apache/hadoop/mrunit line 96 Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference FileInputFormat.java MR/src/java/org/apache/hadoop/mapred line 52 Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference FileInputFormat.java MR/src/java/org/apache/hadoop/mapred line 196 Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference Job.java MR/src/java/org/apache/hadoop/mapreduce line 235 Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference Mapper.java MR/src/java/org/apache/hadoop/mapreduce line 41 Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference Mapper.java MR/src/java/org/apache/hadoop/mapreduce line 44 Javadoc: 'public' visibility for malformed doc comments hides this 'protected' reference FileInputFormat.java MR/src/java/org/apache/hadoop/mapreduce/lib/input line 48 Javadoc: Exception Exception is not declared ImportOptions.java MR/src/contrib/sqoop/src/java/org/apache/hadoop/sqoop line 389 Javadoc: Exception Exception is not declared ImportOptions.java MR/src/contrib/sqoop/src/java/org/apache/hadoop/sqoop line 526 Javadoc: Exception IOException is not declared DistributedCache.java MR/src/java/org/apache/hadoop/mapreduce/filecache line 596 Javadoc: Exception IOException is not declared DistributedCache.java MR/src/java/org/apache/hadoop/mapreduce/filecache line 607 Javadoc: HalfWaitingMapper cannot be resolved to a type TestJobTrackerRestart.java MR/src/test/mapred/org/apache/hadoop/mapred line 145 Javadoc: Invalid member type qualification SequenceFileInputFilter.java MR/src/java/org/apache/hadoop/mapreduce/lib/input line 135 Javadoc: Invalid member type qualification SequenceFileInputFilter.java MR/src/java/org/apache/hadoop/mapreduce/lib/input line 179 Javadoc: Invalid member type qualification SequenceFileInputFilter.java MR/src/java/org/apache/hadoop/mapreduce/lib/input line 240 Javadoc: Invalid param tag name PriorityAuthorization.java MR/src/contrib/dynamic-scheduler/src/java/org/apache/hadoop/mapred line 172 Javadoc: Job cannot be resolved to a type DelegatingMapper.java MR/src/java/org/apache/hadoop/mapreduce/lib/input line 31 Javadoc: JobContext cannot be resolved to a type FileSplit.java MR/src/java/org/apache/hadoop/mapreduce/lib/input line 33 Javadoc: Malformed link reference JobConf.java MR/src/java/org/apache/hadoop/mapred line 1545 Javadoc: Missing #: "Configuration.getJar()})," TaskRunner.java MR/src/java/org/apache/hadoop/mapred line 702 Javadoc: Missing closing brace for inline tag MultithreadedMapper.java MR/src/java/org/apache/hadoop/mapreduce/lib/map line 51 Javadoc: Missing reference UlimitApp.java MR/src/contrib/streaming/src/test/org/apache/hadoop/streaming line 27 Javadoc: Missing return type description CapacitySchedulerConf.java MR/src/contrib/capacity-scheduler/src/java/org/apache/hadoop/mapred line 376 Javadoc: Missing return type description CapacitySchedulerConf.java MR/src/contrib/capacity-scheduler/src/java/org/apache/hadoop/mapred line 394 Javadoc: Missing return type description JSPUtil.java MR/src/java/org/apache/hadoop/mapred line 95 Javadoc: Missing return type description TaskInProgress.java MR/src/java/org/apache/hadoop/mapred line 795 Javadoc: Missing return type description TaskScheduler.java MR/src/java/org/apache/hadoop/mapred line 91 Javadoc: OutputFormat cannot be resolved to a type RawKeyTextOutputFormat.java MR/src/contrib/sqoop/src/java/org/apache/hadoop/sqoop/mapred line 37 Javadoc: Parameter aStartingDir is not declared FileListing.java MR/src/contrib/sqoop/src/java/org/apache/hadoop/sqoop/util line 108 Javadoc: Parameter database is not declared ImportOptions.java MR/src/contrib/sqoop/src/java/org/apache/hadoop/sqoop line 126 Javadoc: Parameter datatype is not declared JobStatisticsInterface.java MR/src/contrib/vaidya/src/java/org/apache/hadoop/vaidya/statistics/job line 64 Javadoc: Parameter debugCommand is not declared TestMiniMRMapRedDebugScript.java MR/src/test/mapred/org/apache/hadoop/mapred line 107 Javadoc: Parameter fileName is not declared XMLUtils.java MR/src/contrib/vaidya/src/java/org/apache/hadoop/vaidya/util line 151 Javadoc: Parameter jobConf is not declared JobStatistics.java MR/src/contrib/vaidya/src/java/org/apache/hadoop/vaidya/statistics/job line 76 Javadoc: Parameter jobHistoryLogFile is not declared PostExPerformanceDiagnoser.java MR/src/contrib/vaidya/src/java/org/apache/hadoop/vaidya/postexdiagnosis line 94 Javadoc: Parameter jobInProgressListener is not declared TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 49 Javadoc: Parameter jobInProgressListener is not declared TaskTrackerManager.java MR/src/java/org/apache/hadoop/mapred line 56 Javadoc: Parameter recordOffset is not declared BufferSorter.java MR/src/java/org/apache/hadoop/mapred line 47 Javadoc: Parameter specificMgr is not declared SqlManager.java MR/src/contrib/sqoop/src/java/org/apache/hadoop/sqoop/manager line 57 Javadoc: Parameter tableClassName is not declared ClassLoaderStack.java MR/src/contrib/sqoop/src/java/org/apache/hadoop/sqoop/util line 57 Javadoc: Parameter testsConfFile is not declared PostExPerformanceDiagnoser.java MR/src/contrib/vaidya/src/java/org/apache/hadoop/vaidya/postexdiagnosis line 95 Javadoc: RM_CONF_FILE cannot be resolved to a type CapacitySchedulerConf.java MR/src/contrib/capacity-scheduler/src/java/org/apache/hadoop/mapred line 109 Javadoc: The method assignTasks(TaskTracker) in the type TaskScheduler is not applicable for the arguments (TaskTrackerStatus) TestTTMemoryReporting.java MR/src/test/mapred/org/apache/hadoop/mapred line 41 Javadoc: The method equals(Object) in the type Pair is not applicable for the arguments (Pair) TestPair.java MR/src/contrib/mrunit/src/test/org/apache/hadoop/mrunit/types line 34 Javadoc: The method getNumberOfThreads(JobContext) in the type MultithreadedMapper is not applicable for the arguments (Configuration) MultithreadedMapper.java MR/src/java/org/apache/hadoop/mapreduce/lib/map line 51 Javadoc: The method map(Object, Object, Mapper.Context) in the type Mapper is not applicable for the arguments (Object, Object, Mapper.Context) Mapper.java MR/src/java/org/apache/hadoop/mapreduce line 42 Javadoc: The method obtainNewMapTask(TaskTrackerStatus, int, int) in the type JobInProgress is not applicable for the arguments (TaskTrackerStatus, int) DefaultTaskSelector.java MR/src/contrib/fairscheduler/src/java/org/apache/hadoop/mapred line 25 Javadoc: The method obtainNewReduceTask(TaskTrackerStatus, int, int) in the type JobInProgress is not applicable for the arguments (TaskTrackerStatus, int) DefaultTaskSelector.java MR/src/contrib/fairscheduler/src/java/org/apache/hadoop/mapred line 26 Javadoc: The method reduce(Object, Iterable, Reducer.Context) in the type Reducer is not applicable for the arguments (Object, Iterable, Reducer.Context) Reducer.java MR/src/java/org/apache/hadoop/mapreduce line 86 Javadoc: The method setMapperClass(Job, Class>) in the type MultithreadedMapper is not applicable for the arguments (Configuration, Class) MultithreadedMapper.java MR/src/java/org/apache/hadoop/mapreduce/lib/map line 49 Javadoc: The method setSchedulingInfo(String, Object) is undefined for the type QueueManager QueueManager.java MR/src/java/org/apache/hadoop/mapred line 245 Javadoc: The method write(KEYOUT, VALUEOUT) in the type TaskInputOutputContext is not applicable for the arguments (Object, Object) Reducer.java MR/src/java/org/apache/hadoop/mapreduce line 91 Javadoc: Unexpected tag TestDriver.java MR/src/contrib/mrunit/src/java/org/apache/hadoop/mrunit line 63 Javadoc: Unexpected tag TestDriver.java MR/src/contrib/mrunit/src/java/org/apache/hadoop/mrunit line 126 Javadoc: Unexpected tag MultithreadedMapRunner.java MR/src/java/org/apache/hadoop/mapred/lib line 40 Javadoc: Unexpected tag ValueAggregatorReducer.java MR/src/java/org/apache/hadoop/mapred/lib/aggregate line 49 Javadoc: Unexpected tag MultithreadedMapper.java MR/src/java/org/apache/hadoop/mapreduce/lib/map line 43 Javadoc: Unexpected tag TestQueueAclsForCurrentUser.java MR/src/test/mapred/org/apache/hadoop/mapred line 58 Javadoc: WordCount.MapClass cannot be resolved to a type MultiFileWordCount.java MR/src/examples/org/apache/hadoop/examples line 202 {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.