You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@dubbo.apache.org by "khanimteyaz (GitHub)" <gi...@apache.org> on 2018/12/07 12:57:48 UTC

[GitHub] [incubator-dubbo] khanimteyaz opened pull request #2921: Added javadoc for dubbo-filter module dubbo github issue 2884

## What is the purpose of the change

Improving the java doc coverage of dubbo-filter module

## Brief changelog

Added javadoc and comments on class, constructor and method level, with example if configuration driven.

## Verifying this change

XXXXX

Follow this checklist to help us incorporate your contribution quickly and easily:

- [x] Make sure there is a [GITHUB_issue](https://github.com/apache/incubator-dubbo/issues) field for the change (usually before you start working on it). Trivial changes like typos do not require a GITHUB issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
- [ ] Format the pull request title like `[Dubbo-XXX] Fix UnknownException when host config not exist #XXX`. Each commit in the pull request should have a meaningful subject line and body.
- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [ ] Write necessary unit-test to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in [test module](https://github.com/apache/incubator-dubbo/tree/master/dubbo-test).
- [ ] Run `mvn clean install -DskipTests` & `mvn clean test-compile failsafe:integration-test` to make sure unit-test and integration-test pass.
- [ ] If this contribution is large, please follow the [Software Donation Guide](https://github.com/apache/incubator-dubbo/wiki/Software-donation-guide).


[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2921 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org


[GitHub] [incubator-dubbo] codecov-io commented on issue #2921: Added javadoc for dubbo-filter module dubbo github issue 2884

Posted by "codecov-io (GitHub)" <gi...@apache.org>.
# [Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2921?src=pr&el=h1) Report
> Merging [#2921](https://codecov.io/gh/apache/incubator-dubbo/pull/2921?src=pr&el=desc) into [master](https://codecov.io/gh/apache/incubator-dubbo/commit/e16e78ff18997d595139a6561bea005e043fd568?src=pr&el=desc) will **decrease** coverage by `0.01%`.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/graphs/tree.svg?width=650&token=VnEIkiFQT0&height=150&src=pr)](https://codecov.io/gh/apache/incubator-dubbo/pull/2921?src=pr&el=tree)

```diff
@@            Coverage Diff            @@
##           master   #2921      +/-   ##
=========================================
- Coverage   63.71%   63.7%   -0.02%     
=========================================
  Files         578     578              
  Lines       25928   25928              
  Branches     4539    4539              
=========================================
- Hits        16521   16517       -4     
- Misses       7235    7241       +6     
+ Partials     2172    2170       -2
```


| [Impacted Files](https://codecov.io/gh/apache/incubator-dubbo/pull/2921?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [...bo/cache/support/threadlocal/ThreadLocalCache.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci1jYWNoZS9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZHViYm8vY2FjaGUvc3VwcG9ydC90aHJlYWRsb2NhbC9UaHJlYWRMb2NhbENhY2hlLmphdmE=) | `100% <ø> (ø)` | :arrow_up: |
| [.../org/apache/dubbo/cache/support/jcache/JCache.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci1jYWNoZS9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZHViYm8vY2FjaGUvc3VwcG9ydC9qY2FjaGUvSkNhY2hlLmphdmE=) | `82.6% <ø> (ø)` | :arrow_up: |
| [...bo/validation/support/jvalidation/JValidation.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci12YWxpZGF0aW9uL3NyYy9tYWluL2phdmEvb3JnL2FwYWNoZS9kdWJiby92YWxpZGF0aW9uL3N1cHBvcnQvanZhbGlkYXRpb24vSlZhbGlkYXRpb24uamF2YQ==) | `100% <ø> (ø)` | :arrow_up: |
| [...he/dubbo/cache/support/expiring/ExpiringCache.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci1jYWNoZS9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZHViYm8vY2FjaGUvc3VwcG9ydC9leHBpcmluZy9FeHBpcmluZ0NhY2hlLmphdmE=) | `100% <ø> (ø)` | :arrow_up: |
| [...o/cache/support/expiring/ExpiringCacheFactory.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci1jYWNoZS9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZHViYm8vY2FjaGUvc3VwcG9ydC9leHBpcmluZy9FeHBpcmluZ0NhY2hlRmFjdG9yeS5qYXZh) | `100% <ø> (ø)` | :arrow_up: |
| [...pache/dubbo/cache/support/lru/LruCacheFactory.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci1jYWNoZS9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZHViYm8vY2FjaGUvc3VwcG9ydC9scnUvTHJ1Q2FjaGVGYWN0b3J5LmphdmE=) | `100% <ø> (ø)` | :arrow_up: |
| [...ava/org/apache/dubbo/cache/filter/CacheFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci1jYWNoZS9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZHViYm8vY2FjaGUvZmlsdGVyL0NhY2hlRmlsdGVyLmphdmE=) | `76.19% <ø> (ø)` | :arrow_up: |
| [...ache/dubbo/validation/filter/ValidationFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci12YWxpZGF0aW9uL3NyYy9tYWluL2phdmEvb3JnL2FwYWNoZS9kdWJiby92YWxpZGF0aW9uL2ZpbHRlci9WYWxpZGF0aW9uRmlsdGVyLmphdmE=) | `85.71% <ø> (ø)` | :arrow_up: |
| [...e/support/threadlocal/ThreadLocalCacheFactory.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci1jYWNoZS9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZHViYm8vY2FjaGUvc3VwcG9ydC90aHJlYWRsb2NhbC9UaHJlYWRMb2NhbENhY2hlRmFjdG9yeS5qYXZh) | `100% <ø> (ø)` | :arrow_up: |
| [...a/org/apache/dubbo/cache/support/lru/LruCache.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree#diff-ZHViYm8tZmlsdGVyL2R1YmJvLWZpbHRlci1jYWNoZS9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvZHViYm8vY2FjaGUvc3VwcG9ydC9scnUvTHJ1Q2FjaGUuamF2YQ==) | `100% <ø> (ø)` | :arrow_up: |
| ... and [15 more](https://codecov.io/gh/apache/incubator-dubbo/pull/2921/diff?src=pr&el=tree-more) | |

------

[Continue to review full report at Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2921?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2921?src=pr&el=footer). Last update [e16e78f...f8e4ae5](https://codecov.io/gh/apache/incubator-dubbo/pull/2921?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).


[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2921 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org

[GitHub] [incubator-dubbo] ralf0131 commented on issue #2921: Added javadoc for dubbo-filter module dubbo github issue 2884

Posted by "ralf0131 (GitHub)" <gi...@apache.org>.
LGTM, thanks for the pull request!

[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2921 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org


[GitHub] [incubator-dubbo] ralf0131 closed pull request #2921: Added javadoc for dubbo-filter module dubbo github issue 2884

Posted by "ralf0131 (GitHub)" <gi...@apache.org>.
[ pull request closed by ralf0131 ]

[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2921 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org


[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2921: Added javadoc for dubbo-filter module dubbo github issue 2884

Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
@ralf0131  thanks for including this and closing.

[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2921 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org