-
Notifications
You must be signed in to change notification settings - Fork 865
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
JAVA-3101: CqlVector#from subtypeCodec parameter missing javadoc description #1739
Open
SiyaoIsHiding
wants to merge
3
commits into
apache:4.x
Choose a base branch
from
SiyaoIsHiding:javadoc
base: 4.x
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
SiyaoIsHiding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
| <project version="4" relativePaths="false"> | ||
| <component name="ProjectRootManager" version="2" assert-keyword="true" project-jdk-name="1.8" jdk-15="true"/> | ||
| <component name="CodeStyleManager"> | ||
| <option name="USE_DEFAULT_CODE_STYLE_SCHEME" value="true"/> | ||
| <option name="CODE_STYLE_SCHEME" value=""/> | ||
| </component> | ||
| <component name="libraryTable"/> | ||
| <component name="CompilerConfiguration"> | ||
| <option name="DEFAULT_COMPILER" value="Javac"/> | ||
| <option name="CLEAR_OUTPUT_DIRECTORY" value="false"/> | ||
| <!-- | ||
| <wildcardResourcePatterns> | ||
| <entry name="${wildcardResourcePattern}"/> | ||
| </wildcardResourcePatterns> | ||
| --> | ||
| <wildcardResourcePatterns> | ||
| <entry name="!?*.java"/> | ||
| </wildcardResourcePatterns> | ||
| </component> | ||
| <component name="JavacSettings"> | ||
| <option name="DEBUGGING_INFO" value="true"/> | ||
| <option name="GENERATE_NO_WARNINGS" value="false"/> | ||
| <option name="DEPRECATION" value="true"/> | ||
| <option name="ADDITIONAL_OPTIONS_STRING" value=""/> | ||
| <option name="MAXIMUM_HEAP_SIZE" value="128"/> | ||
| <option name="USE_GENERICS_COMPILER" value="false"/> | ||
| </component> | ||
| <component name="JikesSettings"> | ||
| <option name="DEBUGGING_INFO" value="true"/> | ||
| <option name="DEPRECATION" value="true"/> | ||
| <option name="GENERATE_NO_WARNINGS" value="false"/> | ||
| <option name="GENERATE_MAKE_FILE_DEPENDENCIES" value="false"/> | ||
| <option name="DO_FULL_DEPENDENCE_CHECK" value="false"/> | ||
| <option name="IS_INCREMENTAL_MODE" value="false"/> | ||
| <option name="IS_EMACS_ERRORS_MODE" value="true"/> | ||
| <option name="ADDITIONAL_OPTIONS_STRING" value=""/> | ||
| <option name="MAXIMUM_HEAP_SIZE" value="128"/> | ||
| </component> | ||
| <component name="AntConfiguration"> | ||
| <option name="IS_AUTOSCROLL_TO_SOURCE" value="false"/> | ||
| <option name="FILTER_TARGETS" value="false"/> | ||
| </component> | ||
| <component name="JavadocGenerationManager"> | ||
| <option name="OUTPUT_DIRECTORY"/> | ||
| <option name="OPTION_SCOPE" value="protected"/> | ||
| <option name="OPTION_HIERARCHY" value="false"/> | ||
| <option name="OPTION_NAVIGATOR" value="false"/> | ||
| <option name="OPTION_INDEX" value="false"/> | ||
| <option name="OPTION_SEPARATE_INDEX" value="false"/> | ||
| <option name="OPTION_USE_1_1" value="false"/> | ||
| <option name="OPTION_DOCUMENT_TAG_USE" value="false"/> | ||
| <option name="OPTION_DOCUMENT_TAG_AUTHOR" value="false"/> | ||
| <option name="OPTION_DOCUMENT_TAG_VERSION" value="false"/> | ||
| <option name="OPTION_DOCUMENT_TAG_DEPRECATED" value="false"/> | ||
| <option name="OPTION_DEPRECATED_LIST" value="false"/> | ||
| <option name="OTHER_OPTIONS"/> | ||
| <option name="HEAP_SIZE"/> | ||
| <option name="OPEN_IN_BROWSER" value="false"/> | ||
| </component> | ||
| <component name="JUnitProjectSettings"> | ||
| <option name="TEST_RUNNER" value="UI"/> | ||
| </component> | ||
| <component name="EntryPointsManager"> | ||
| <entry_points/> | ||
| </component> | ||
| <component name="DataSourceManager"/> | ||
| <component name="ExportToHTMLSettings"> | ||
| <option name="PRINT_LINE_NUMBERS" value="false"/> | ||
| <option name="OPEN_IN_BROWSER" value="false"/> | ||
| <option name="OUTPUT_DIRECTORY"/> | ||
| </component> | ||
| <component name="ImportConfiguration"> | ||
| <option name="VENDOR"/> | ||
| <option name="RELEASE_TAG"/> | ||
| <option name="LOG_MESSAGE"/> | ||
| <option name="CHECKOUT_AFTER_IMPORT" value="true"/> | ||
| </component> | ||
| <component name="ProjectModuleManager"> | ||
| <modules> | ||
| <!-- module filepath="$$PROJECT_DIR$$/${pom.artifactId}.iml"/ --> | ||
| <module filepath="$PROJECT_DIR$/java-driver-parent.iml"/> | ||
| <module filepath="$PROJECT_DIR$/core/java-driver-core.iml"/> | ||
| <module filepath="$PROJECT_DIR$/core-shaded/java-driver-core-shaded.iml"/> | ||
| <module filepath="$PROJECT_DIR$/query-builder/java-driver-query-builder.iml"/> | ||
| <module filepath="$PROJECT_DIR$/mapper-runtime/java-driver-mapper-runtime.iml"/> | ||
| <module filepath="$PROJECT_DIR$/mapper-processor/java-driver-mapper-processor.iml"/> | ||
| <module filepath="$PROJECT_DIR$/metrics/micrometer/java-driver-metrics-micrometer.iml"/> | ||
| <module filepath="$PROJECT_DIR$/metrics/microprofile/java-driver-metrics-microprofile.iml"/> | ||
| <module filepath="$PROJECT_DIR$/test-infra/java-driver-test-infra.iml"/> | ||
| <module filepath="$PROJECT_DIR$/integration-tests/java-driver-integration-tests.iml"/> | ||
| <module filepath="$PROJECT_DIR$/osgi-tests/java-driver-osgi-tests.iml"/> | ||
| <module filepath="$PROJECT_DIR$/distribution/java-driver-distribution.iml"/> | ||
| <module filepath="$PROJECT_DIR$/examples/java-driver-examples.iml"/> | ||
| <module filepath="$PROJECT_DIR$/bom/java-driver-bom.iml"/> | ||
| </modules> | ||
| </component> | ||
| <UsedPathMacros> | ||
| <!--<macro name="cargo"></macro>--> | ||
| </UsedPathMacros> | ||
| </project> | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is true but it doesn't really tell us which string representation we're talking about :)
Vectors in CQL have a form that looks something like this:
The first parameter there is the subtype of this vector, that is the type of values it contains. The second is it's size parameter.
The subtypeCodec in CqlVector is intended to parse the string representation of the subtype so that we can build new instances of that subtype for the values contained by the vector. So you probably want to say something like "the codec to parse the string representation of subtype values" here (or something similar) in order to make it very clear what values we're talking about.
Make sense?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your detailed explanation! Just changed to
the TypeCodec to parse the string representation of subtype values.