This repository has been archived by the owner on Aug 8, 2023. It is now read-only.
Add javadoc code examples #11540
Merged
Add javadoc code examples #11540
Conversation
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
tobrun
force-pushed
the
tvn-add-javadoc-code-examples
branch
from
87922d5
to
c5a06d2
Compare
tobrun
force-pushed
the
tvn-add-javadoc-code-examples
branch
from
c5a06d2
to
41d89a1
Compare
|
Ready for review @LukasPaczos |
LukasPaczos
reviewed
Apr 10, 2018
There was a problem hiding this comment.
Great seeing code examples in the javadoc itself! 🚀
While we are at it, some nice-to-haves:
- example usage of
Expression#properties()andExpression#geometryType() - javadoc indication that
Expression#string,Expression#numberetc. return the first type-matching object rather than a boolean that it's present in the set - code example for
exponential(@NonNull Expression expression) - more complicated styling example combining a couple of expressions at the top of the class?
| * symbolLayer.setProperties( | ||
| * iconSize( | ||
| * switchCase( | ||
| * get(KEY_PROPERTY_SELECTED), literal(3.0f), |
There was a problem hiding this comment.
Maybe one more case option before default?
There was a problem hiding this comment.
that would make it a bit more clear + also added // default value:
* symbolLayer.setProperties(
* iconSize(
* switchCase(
* get(KEY_TO_BOOLEAN), literal(3.0f),
* get(KEY_TO_OTHER_BOOLEAN), literal(5.0f)
* literal(1.0f) // default value
* )
* )
* );
| @@ -569,6 +986,7 @@ public static Expression match(@NonNull Expression input, @NonNull Expression de | |||
|
|
|||
| /** | |||
| * Evaluates each expression in turn until the first non-null value is obtained, and returns that value. | |||
| * // TODO: 26/03/2018 javadoc example | |||
| * {@code | ||
| * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); | ||
| * symbolLayer.setProperties( | ||
| * textField(get(literal("key-to-feature"), properties())) |
There was a problem hiding this comment.
Doesn't this result in a call without a second argument, get("key-to-feature")? Can we add an example that uses a different properties object?
| * {@code | ||
| * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); | ||
| * symbolLayer.setProperties( | ||
| * textField(get("key-to-feature", properties())) |
| * {@code | ||
| * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); | ||
| * fillLayer.setFilter( | ||
| * has(string("keyToValue")) |
There was a problem hiding this comment.
Shouldn't this be has(literal("keyToValue"))?
There was a problem hiding this comment.
actually has(get("keyToValue"))
| * FillLayer fillLayer = new fillLayer("layer-id", "source-id"); | ||
| * fillLayer.setProperties( | ||
| * fillColor( | ||
| * exponential(0.5f), zoom(), |
| * FillLayer fillLayer = new fillLayer("layer-id", "source-id"); | ||
| * fillLayer.setProperties( | ||
| * fillColor( | ||
| * linear(), zoom(), |
| * FillLayer fillLayer = new fillLayer("layer-id", "source-id"); | ||
| * fillLayer.setProperties( | ||
| * fillColor( | ||
| * exponential(0.5f), zoom(), |
| * FillLayer fillLayer = new fillLayer("layer-id", "source-id"); | ||
| * fillLayer.setProperties( | ||
| * fillColor( | ||
| * cubicBezier(0.42f, 0.0f, 1.0f, 1.0f), zoom(), |
| * FillLayer fillLayer = new fillLayer("layer-id", "source-id"); | ||
| * fillLayer.setProperties( | ||
| * fillColor( | ||
| * cubicBezier(0.42f, 0.0f, 1.0f, 1.0f), zoom(), |
tobrun
force-pushed
the
tvn-add-javadoc-code-examples
branch
from
41d89a1
to
109439e
Compare
tobrun
force-pushed
the
tvn-add-javadoc-code-examples
branch
from
109439e
to
7fd0d14
Compare
This was referenced Apr 10, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
WIP, this PR adds inline expression code examples to the javadoc.
closes #11159