Enhance Javadoc for non-dynamic Image constructors#3383
Merged
HeikoKlare merged 1 commit intoJun 17, 2026
Merged
Conversation
Contributor
HeikoKlare
force-pushed
the
javadoc-image-static-constructors
branch
from
e347071 to
63dd2a7
Compare
HeikoKlare
force-pushed
the
javadoc-image-static-constructors
branch
from
63dd2a7 to
134d221
Compare
Images may be requested at different zooms, depending on the context and which they are used. Most types of images are able to generate image data for different zooms from their data source, such as an ImageDataProvider or ImageGcDrawer. The Image constructors accepting width and height or a Rectangle reflecting width and heights are usually used together with a GC that drawn on them. This usually produces proper image data for one zoom only. This change enhances the Javadoc of those constructors to emphasize that they should only be used if none of the other constructors, in particular the one accepting an ImageGcDrawer, are applicable. For this, a statement about limitations for Windows ME and older are removed.
HeikoKlare
force-pushed
the
javadoc-image-static-constructors
branch
from
134d221 to
0cf5703
Compare
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
1 participant
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.
Images may be requested at different zooms, depending on the context and which they are used. Most types of images are able to generate image data for different zooms from their data source, such as an ImageDataProvider or ImageGcDrawer. The Image constructors accepting width and height or a Rectangle reflecting width and heights are usually used together with a GC that drawn on them. This usually produces proper image data for one zoom only.
This change enhances the Javadoc of those constructors to emphasize that they should only be used if none of the other constructors, in particular the one accepting an ImageGcDrawer, are applicable. For this, a statement about limitations for Windows ME and older are removed.