[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/flink/pull/1298


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on the pull request:

https://github.com/apache/flink/pull/1298#issuecomment-152122441
  
I will merge this PR.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on the pull request:

https://github.com/apache/flink/pull/1298#issuecomment-151823317
  
OK, I can do it as well.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[hczerpak]

Github user hczerpak commented on the pull request:

https://github.com/apache/flink/pull/1298#issuecomment-151820648
  
I'm sorry @fhueske but honestly I don't know how to squash the history. 
After few tires I've given up yesterday, it didn't happen correctly.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on the pull request:

https://github.com/apache/flink/pull/1298#issuecomment-151786552
  
Thanks for the update.
Looks good to merge.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43153270
  
--- Diff: 
flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/MessagingFunction.java
 ---
@@ -327,7 +327,7 @@ void setInDegree(long inDegree) {
 
/**
 * Retrieve the vertex out-degree (number of out-going edges).
-* @return The out-degree of this vertex if the {@link 
IterationConfiguration#setOptDegrees(boolean)}
+* @return The out-degree of this vertex
--- End diff --

the `if` part is missing


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43158439
  
--- Diff: 
flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/util/SplitStreamType.java
 ---
@@ -20,10 +20,11 @@
 import org.apache.flink.streaming.api.datastream.DataStream;
 
 /**
- * Used by {@link org.apache.flink.storm.wrappers.AbstractStormCollector 
AbstractStormCollector} to wrap
+ * Used by org.apache.flink.storm.wrappers.AbstractStormCollector to wrap
--- End diff --

Sounds good to me.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[hczerpak]

Github user hczerpak commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43157767
  
--- Diff: 
flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/MessagingFunction.java
 ---
@@ -314,7 +314,7 @@ public void remove() {
 
/**
 * Retrieves the vertex in-degree (number of in-coming edges).
-* @return The in-degree of this vertex if the {@link 
IterationConfiguration#setOptDegrees(boolean)}
+* @return The in-degree of this vertex
--- End diff --

There is no IterationConfiguration#setOptDegrees(boolean) any more and if 
you look at the source code which this javadoc relates to it. It looked like 
copy-paste comment from somewhere else.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43153428
  
--- Diff: 
flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/VertexUpdateFunction.java
 ---
@@ -206,7 +206,7 @@ void setOutput(Vertex outVal, 
Collector> out) {
 
/**
 * Retrieves the vertex in-degree (number of in-coming edges).
-* @return The in-degree of this vertex if the {@link 
IterationConfiguration#setOptDegrees(boolean)}
+* @return The in-degree of this vertex
--- End diff --

the `if` part is missing


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43153436
  
--- Diff: 
flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/VertexUpdateFunction.java
 ---
@@ -219,7 +219,7 @@ void setInDegree(long inDegree) {
 
/**
 * Retrieve the vertex out-degree (number of out-going edges).
-* @return The out-degree of this vertex if the {@link 
IterationConfiguration#setOptDegrees(boolean)}
+* @return The out-degree of this vertex
--- End diff --

the `if` part is missing


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[hczerpak]

Github user hczerpak closed the pull request at:

https://github.com/apache/flink/pull/1298


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43158080
  
--- Diff: 
flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/MessagingFunction.java
 ---
@@ -314,7 +314,7 @@ public void remove() {
 
/**
 * Retrieves the vertex in-degree (number of in-coming edges).
-* @return The in-degree of this vertex if the {@link 
IterationConfiguration#setOptDegrees(boolean)}
+* @return The in-degree of this vertex
--- End diff --

I see, but the next line should be removed then as well, right?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[hczerpak]

GitHub user hczerpak reopened a pull request:

https://github.com/apache/flink/pull/1298

[FLINK-2559] Fix Javadoc Code Examples

Initially I've made only handful of fixes to javadocs, replacing few @ with 
 {@literal @}. Running mvn javadoc:javadoc revealed lots of javadoc  problems:

- broken html tags: `, , .`
- unclosed html tags e.g. `...`
- lots of > and < characters used directly in javadoc
- source code examples not wrapped with {@code }
- incorrect references to classes, methods in @see or @link tags
- @throws tags when no exception is being thrown (or different)
- no @throws when exception is being thrown from method
- typos 


Unfortunately Travis doesn't run javadocs compilation and it will not show 
that it actually works 

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/hczerpak/flink FLINK-2559

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/flink/pull/1298.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #1298


commit 06caac6c90d8c888c326fe9b41552b2241ba584c
Author: hczerpak 
Date:   2015-10-22T10:10:08Z

Merge remote-tracking branch 'apache/master'

commit 63bd9833bb6e396ea91f3b98e863079e0d764773
Author: hczerpak 
Date:   2015-10-22T13:27:18Z

Merge remote-tracking branch 'apache/master'

commit 3d86dd79e0735b1ddb052d07bc23f476d4512168
Author: Hubert Czerpak 
Date:   2015-10-22T19:42:31Z

Merge remote-tracking branch 'apache/master' into FLINK-2559

commit d4f770aed5ecb61ab66f442e7d5e28ef7b18338e
Author: Hubert Czerpak 
Date:   2015-10-22T21:51:25Z

@literal

Replaced @ character with {@literal @} in few places. Not so many
occurrences.
One  was not needed to be html encoded.

commit 63f6dd07252ebbfc583e6de2520e15b88332ad97
Author: Hubert Czerpak 
Date:   2015-10-23T09:15:37Z

Merge remote-tracking branch 'apache/master' into FLINK-2559

commit 23768356487f4f062f491f7617cb8ebfeb952392
Author: Hubert Czerpak 
Date:   2015-10-23T10:31:22Z

Merge remote-tracking branch 'apache/master' into FLINK-2559

commit 516be48b02016a68ef049f9074326eb1f75f7e6c
Author: Hubert Czerpak 
Date:   2015-10-23T14:42:11Z

all javadoc is building fine now

Removed all javadoc compilation errors

commit 679630d13ec4909025f4f9aa4bddfd492824c58a
Author: Hubert Czerpak 
Date:   2015-10-23T14:42:24Z

Merge remote-tracking branch 'apache/master' into FLINK-2559

commit 940e1f317b7a5af613ea551cd8978cc799d6fac1
Author: Hubert Czerpak 
Date:   2015-10-23T17:17:24Z

Merge remote-tracking branch 'apache/master' into FLINK-2559




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[hczerpak]

Github user hczerpak commented on the pull request:

https://github.com/apache/flink/pull/1298#issuecomment-151583330
  
Sure. I appreciate your comments. It was not always straightforward what to 
do with errors. Could you please take a look at my comments above and say what 
you think?

thanks


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on the pull request:

https://github.com/apache/flink/pull/1298#issuecomment-151576323
  
Hi @hczerpak, thanks a lot for the thorough cleaning of the JavaDocs!
I spotted just a few things that should be improved.
The commit history of your PR is also a bit messy. Would you mind to rebase 
it to get rid of the merge commits?

Thanks again, Fabian


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[hczerpak]

Github user hczerpak commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43157321
  
--- Diff: 
flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Entities.java
 ---
@@ -21,8 +21,8 @@
 import java.util.List;
 
 /**
- * Entities which have been parsed out of the text of the
- * {@link package 
org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet}.
+ * entities which have been parsed out of the text of the
--- End diff --

Good point. Didn't intend to lower that case.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43151435
  
--- Diff: 
flink-contrib/flink-tweet-inputformat/src/main/java/org/apache/flink/contrib/tweetinputformat/model/tweet/entities/Entities.java
 ---
@@ -21,8 +21,8 @@
 import java.util.List;
 
 /**
- * Entities which have been parsed out of the text of the
- * {@link package 
org.apache.flink.contrib.tweetinputformat.model.tweet.Tweet}.
+ * entities which have been parsed out of the text of the
--- End diff --

Why lowercase?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[hczerpak]

Github user hczerpak commented on the pull request:

https://github.com/apache/flink/pull/1298#issuecomment-151583549
  
Sorry for missclick. Didn't intend to close and reopen


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43151247
  
--- Diff: 
flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/util/SplitStreamType.java
 ---
@@ -20,10 +20,11 @@
 import org.apache.flink.streaming.api.datastream.DataStream;
 
 /**
- * Used by {@link org.apache.flink.storm.wrappers.AbstractStormCollector 
AbstractStormCollector} to wrap
+ * Used by org.apache.flink.storm.wrappers.AbstractStormCollector to wrap
--- End diff --

Why did you remove this link?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43153252
  
--- Diff: 
flink-libraries/flink-gelly/src/main/java/org/apache/flink/graph/spargel/MessagingFunction.java
 ---
@@ -314,7 +314,7 @@ public void remove() {
 
/**
 * Retrieves the vertex in-degree (number of in-coming edges).
-* @return The in-degree of this vertex if the {@link 
IterationConfiguration#setOptDegrees(boolean)}
+* @return The in-degree of this vertex
--- End diff --

the `if` part is missing


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[hczerpak]

Github user hczerpak commented on a diff in the pull request:

https://github.com/apache/flink/pull/1298#discussion_r43156806
  
--- Diff: 
flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/util/SplitStreamType.java
 ---
@@ -20,10 +20,11 @@
 import org.apache.flink.streaming.api.datastream.DataStream;
 
 /**
- * Used by {@link org.apache.flink.storm.wrappers.AbstractStormCollector 
AbstractStormCollector} to wrap
+ * Used by org.apache.flink.storm.wrappers.AbstractStormCollector to wrap
--- End diff --

Javadoc couldn't link that class. I'm suspecting because 
AbstractStormCollector has package access and this link has been created from 
outside of that package. The least I could do was to leave raw path to that 
class.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request: [FLINK-2559] Fix Javadoc Code Examples

[fhueske]

Github user fhueske commented on the pull request:

https://github.com/apache/flink/pull/1298#issuecomment-151583907
  
No worries :-)
Thanks for the quick response!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---