CLEANUP: Improve Javadoc and align parameter names#1080
Merged
Conversation
oliviarla
reviewed
Apr 27, 2026
| * @param element btree element to upsert | ||
| * @param attributes collection attributes for creation when the btree does not exist | ||
| * @return {@code Boolean.True} if upserted, {@code Boolean.False} otherwise | ||
| * @return {@code true} if upserted, {@code false} otherwise |
Collaborator
There was a problem hiding this comment.
upsert 시에 true 외에는 null만 반환 가능해보이는데 확인해주세요.
Collaborator
Author
There was a problem hiding this comment.
null 만 반환하는 것으로 확인했습니다.
| * | ||
| * @param keys list of keys to get | ||
| * @return Map of key to value with CAS. | ||
| * @return Map of key to value with CAS |
Collaborator
There was a problem hiding this comment.
value with CAS -> {@link CASValue} 로 변경하면 어떤가요?
만약 괜찮다면 gets 쪽도 변경해주시면 좋겠습니다.
| * the corresponding entry will not be present in the map. | ||
| * @return map of key to {@code BTreeElements} with found elements, | ||
| * empty {@code BTreeElements} if no elements are found in the range but key exists, | ||
| * no entry in the map if the key is not found |
Collaborator
There was a problem hiding this comment.
위에서는 {@code Map.Entry} 표현하고 있어서 여기도 entry 대신 해당 표현 사용하는게 좋겠습니다.
| * @param args arguments for get operation | ||
| * @return {@code SMGetElements} containing sort-merged elements. Never return {@code null}. | ||
| * If matching elements not exist, the elements list in the {@code SMGetElements} will be empty. | ||
| * @return {@code SMGetElements} containing sort-merged elements (never {@code null}), |
Collaborator
There was a problem hiding this comment.
(never {@code null}),을 나타낼 필요가 있을까요? 아래 라인 명시하면 충분히 설명 될 것 같아서요..
Comment on lines
+716
to
+723
| * @param value the value to insert or replace with | ||
| * @return {@code true} if the element was inserted or replaced, | ||
| * {@code null} if the key is not found. | ||
| * {@code null} if the key is not found |
Collaborator
There was a problem hiding this comment.
bop upsert와 유사하게 간단히 표현하면 어떨까요? (replace라는 표현 대신 upsert만으로도 의미가 전달될 것 같습니다.)
Collaborator
Author
There was a problem hiding this comment.
mopUpsert, bopUpsert 두 API 모두 아래와 같이 수정하도록 하겠습니다.
@return {@code true} if upserted, {@code null} if the key is not found| * @param mKeys MKeys of the elements to delete | ||
| * @param dropIfEmpty whether to drop the map if it becomes empty after deletion | ||
| * @return {@code true} if at least one element was deleted, | ||
| * {@code false} if the MKey is not found, |
Collaborator
There was a problem hiding this comment.
if all MKeys are not found, 와 같은 표현이어야 할 것 같습니다.
Collaborator
Author
There was a problem hiding this comment.
{@code false} if no MKeys are found, 으로 수정했습니다.
f1v3-dev
force-pushed
the
refactor/v2-javadoc
branch
from
ef413b5 to
40e14ef
Compare
oliviarla
approved these changes
Apr 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Related Issue
⌨️ What I did
append/prepend파라미터명val→value통일AsyncArcusCommandsIFJavadoc 개선{@code Boolean.True/False}→{@code true/false}수정@return마침표 제거 통일@return다중 케이스 줄바꿈 스타일 통일 (케이스별 한 줄)@return순서 통일 (true→false→null)bopGet,bopMultiGet,bopSortMergeGet반환값 설명 개선delection→deletion,mKeys파라미터 설명 단수 → 복수