[jira] [Commented] (KAFKA-8093) Fix JavaDoc markup

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/KAFKA-8093?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16792175#comment-16792175 ] 

ASF GitHub Bot commented on KAFKA-8093:
---------------------------------------

pkleindl commented on pull request #6439: KAFKA-8093: fixed some javadoc errors
URL: https://github.com/apache/kafka/pull/6439
 
 
   corrected link to Oracle documentation according to https://discuss.gradle.org/t/javadoc-task-link-not-linking-external-javadocs/25264/3
   Question: Should the link really go to 7?
   
   If I run "aggregatedJavadoc" locally I get ERRORs because of
   exclude "**/internals/**":
   
   > Task :aggregatedJavadoc
   /Users/patrik.kleindl/IdeaProjects/kafka_pkleindl/streams/test-utils/src/main/java/org/apache/kafka/streams/processor/MockProcessorContext.java:31: error: cannot find symbol
   import org.apache.kafka.streams.internals.QuietStreamsConfig;
                                            ^
     symbol:   class QuietStreamsConfig
     location: package org.apache.kafka.streams.internals
   /Users/patrik.kleindl/IdeaProjects/kafka_pkleindl/streams/test-utils/src/main/java/org/apache/kafka/streams/TopologyTestDriver.java:43: error: cannot find symbol
   import org.apache.kafka.streams.internals.KeyValueStoreFacade;
                                            ^
     symbol:   class KeyValueStoreFacade
     location: package org.apache.kafka.streams.internals
   /Users/patrik.kleindl/IdeaProjects/kafka_pkleindl/streams/test-utils/src/main/java/org/apache/kafka/streams/TopologyTestDriver.java:44: error: cannot find symbol
   import org.apache.kafka.streams.internals.QuietStreamsConfig;
                                            ^
     symbol:   class QuietStreamsConfig
     location: package org.apache.kafka.streams.internals
   /Users/patrik.kleindl/IdeaProjects/kafka_pkleindl/streams/test-utils/src/main/java/org/apache/kafka/streams/TopologyTestDriver.java:45: error: cannot find symbol
   import org.apache.kafka.streams.internals.WindowStoreFacade;
                                            ^
     symbol:   class WindowStoreFacade
     location: package org.apache.kafka.streams.internals
   4 errors
   
   I guess the problem is that this excludes everything in the path of internals (including test-utils), maybe this was only meant for stuff inside streams?
   
   ### Committer Checklist (excluded from commit message)
   - [ ] Verify design and implementation 
   - [ ] Verify test coverage and CI build status
   - [ ] Verify documentation (including upgrade notes)
   
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Fix JavaDoc markup
> ------------------
>
>                 Key: KAFKA-8093
>                 URL: https://issues.apache.org/jira/browse/KAFKA-8093
>             Project: Kafka
>          Issue Type: Bug
>          Components: KafkaConnect
>            Reporter: Matthias J. Sax
>            Priority: Trivial
>
> Running `./gradlew install` gives the following warning
> {code:java}
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java:87: warning - Tag @link: reference not found: java.nio.channels.Selector
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java:87: warning - Tag @link: reference not found: java.nio.channels.Selector#wakeup() wakeup()
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/connector/ConnectRecord.java:34: warning - Tag @link: reference not found: org.apache.kafka.clients.producer.ProducerRecord ProducerRecord
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/header/Headers.java:261: warning - @Header is an unknown tag.
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/header/Headers.java:261: warning - @Header is an unknown tag.
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/header/Headers.java:261: warning - @Header is an unknown tag.
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/header/Headers.java:261: warning - @Header is an unknown tag.
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/header/Headers.java:261: warning - @Header is an unknown tag.
> /Users/matthias/IdeaProjects/kafka/connect/api/src/main/java/org/apache/kafka/connect/header/Headers.java:261: warning - @Header is an unknown tag.
> {code}
> Those should be fixed



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)