Skip to content

[Dubbo-3001] enhance the java doc of dubbo-rpc module.#5566

Merged
chickenlj merged 1 commit intoapache:masterfrom
ggezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz:patch-3
Feb 9, 2020
Merged

[Dubbo-3001] enhance the java doc of dubbo-rpc module.#5566
chickenlj merged 1 commit intoapache:masterfrom
ggezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz:patch-3

Conversation

@ggezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
Copy link
Copy Markdown

What is the purpose of the change

#3001

Brief changelog

1.dubbo-rpc/dubbo-rpc-rmi/src/main/java/com/alibaba/dubbo/rpc/protocol/rmi/RmiRemoteInvocation.java

Verifying this change

Passed unit tests

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 sample in dubbo samples project.
  • 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.

@htynkn htynkn added type/documentation type/need-triage Need maintainers to triage labels Dec 31, 2019
@htynkn
Copy link
Copy Markdown
Member

htynkn commented Dec 31, 2019

follow javadoc, the format should be

/**
 * @deprecated  As of release 1.3, replaced by {@link #getPreferredSize()}
 */
@Deprecated public Dimension preferredSize() {
return getPreferredSize();
}

But I'm not sure if we add javadoc for this file, should we do same thing for
https://github.com/apache/dubbo/blob/master/dubbo-compatible/src/main/java/com/alibaba/dubbo/rpc/protocol/rest/support/ContentType.java
and other similar files

@chickenlj any thoughts?

@ggezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz ggezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz changed the title enhance the java doc of dubbo-rpc module. [Dubbo-3001] enhance the java doc of dubbo-rpc module. Jan 1, 2020
@chickenlj chickenlj merged commit c3d5700 into apache:master Feb 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/need-triage Need maintainers to triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants