Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance javadoc of dubbo-config #3015

Closed
wants to merge 16 commits into from
Closed

Enhance javadoc of dubbo-config #3015

wants to merge 16 commits into from

Conversation

lixiaojiee
Copy link
Contributor

@lixiaojiee lixiaojiee commented Dec 19, 2018

What is the purpose of the change

Enhance javadoc of dubbo-config

Brief changelog

/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ServiceConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/AbstractConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/AbstractInterfaceConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/AbstractMethodConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/AbstractReferenceConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/AbstractServiceConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ApplicationConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ArgumentConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ConsumerConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/MethodConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ModuleConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/MonitorConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ProtocolConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ProviderConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ReferenceConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/RegistryConfig.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/invoker/DelegateProviderMetaDataInvoker.java
/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/utils/ReferenceConfigCache.java

Verifying this change

ut pass

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

  • Make sure there is a GITHUB_issue 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.
  • Run mvn clean install -DskipTests=false & 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.

@carryxyh
Copy link
Member

Nice work, I'd like take a look.

@codecov-io
Copy link

codecov-io commented Dec 19, 2018

Codecov Report

Merging #3015 into master will decrease coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #3015      +/-   ##
============================================
- Coverage     63.56%   63.47%   -0.09%     
  Complexity       75       75              
============================================
  Files           653      653              
  Lines         28218    28218              
  Branches       4803     4803              
============================================
- Hits          17936    17912      -24     
- Misses         8009     8031      +22     
- Partials       2273     2275       +2
Impacted Files Coverage Δ Complexity Δ
...org/apache/dubbo/config/AbstractServiceConfig.java 95.77% <ø> (ø) 0 <0> (ø) ⬇️
...n/java/org/apache/dubbo/config/ConsumerConfig.java 92.3% <ø> (ø) 0 <0> (ø) ⬇️
...in/java/org/apache/dubbo/config/MonitorConfig.java 100% <ø> (ø) 0 <0> (ø) ⬇️
...pache/dubbo/config/utils/ReferenceConfigCache.java 75% <ø> (ø) 0 <0> (ø) ⬇️
...n/java/org/apache/dubbo/config/AbstractConfig.java 78.45% <ø> (ø) 0 <0> (ø) ⬇️
.../java/org/apache/dubbo/config/ReferenceConfig.java 57.57% <ø> (-0.38%) 0 <0> (ø)
...ava/org/apache/dubbo/config/ApplicationConfig.java 82.71% <ø> (ø) 0 <0> (ø) ⬇️
...ain/java/org/apache/dubbo/config/ModuleConfig.java 86.84% <ø> (ø) 0 <0> (ø) ⬇️
...n/java/org/apache/dubbo/config/RegistryConfig.java 82.35% <ø> (ø) 0 <0> (ø) ⬇️
...in/java/org/apache/dubbo/config/ServiceConfig.java 53.53% <ø> (ø) 0 <0> (ø) ⬇️
... and 21 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f99f015...792f8ac. Read the comment docs.

@khanimteyaz
Copy link
Contributor

@lixiaojiee thanks for the pr.it looks good to me.

@lixiaojiee
Copy link
Contributor Author

Hi,the java doc of incubator-dubbo-config is added, mainly focusing on api module ,please take time to help check whether there is anything inappropriate in it,thanks. @carryxyh

@lixiaojiee
Copy link
Contributor Author

There has many conflicts,and I will solve them, please don't merge

@lixiaojiee
Copy link
Contributor Author

This pr has too many commits and conflicts,I will close it and open a new pr #3103

@lixiaojiee lixiaojiee closed this Dec 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants