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: `<br/>, <p/>, </br>.`
- unclosed html tags e.g. `<i>...<i>`
- 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 <[email protected]>
Date: 2015-10-22T10:10:08Z
Merge remote-tracking branch 'apache/master'
commit 63bd9833bb6e396ea91f3b98e863079e0d764773
Author: hczerpak <[email protected]>
Date: 2015-10-22T13:27:18Z
Merge remote-tracking branch 'apache/master'
commit 3d86dd79e0735b1ddb052d07bc23f476d4512168
Author: Hubert Czerpak <[email protected]>
Date: 2015-10-22T19:42:31Z
Merge remote-tracking branch 'apache/master' into FLINK-2559
commit d4f770aed5ecb61ab66f442e7d5e28ef7b18338e
Author: Hubert Czerpak <[email protected]>
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 <[email protected]>
Date: 2015-10-23T09:15:37Z
Merge remote-tracking branch 'apache/master' into FLINK-2559
commit 23768356487f4f062f491f7617cb8ebfeb952392
Author: Hubert Czerpak <[email protected]>
Date: 2015-10-23T10:31:22Z
Merge remote-tracking branch 'apache/master' into FLINK-2559
commit 516be48b02016a68ef049f9074326eb1f75f7e6c
Author: Hubert Czerpak <[email protected]>
Date: 2015-10-23T14:42:11Z
all javadoc is building fine now
Removed all javadoc compilation errors
commit 679630d13ec4909025f4f9aa4bddfd492824c58a
Author: Hubert Czerpak <[email protected]>
Date: 2015-10-23T14:42:24Z
Merge remote-tracking branch 'apache/master' into FLINK-2559
commit 940e1f317b7a5af613ea551cd8978cc799d6fac1
Author: Hubert Czerpak <[email protected]>
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 [email protected] or file a JIRA ticket
with INFRA.
---
