Improve Javadoc around environment names for #13534 #13674
Conversation
| * Configure the Environment specific Deploy settings. | ||
| * | ||
| * @param name the name of the environment. | ||
| * @param name the name of the environment. This is usually one of "core", "static", |
There was a problem hiding this comment.
These names only exist if you are using jetty standalone.
They come into existence due to the configuration you are using.
The names themselves actually exist in the ${jetty.home}/modules/*.mod files.
On Jetty Embedded (an super common use case) the environment names do not exist.
So documenting them as existing in the javadoc isn't correct.
|
@byteit101 we acknowledge there is missing documentation about this way of using Jetty. The matter should have a more comprehensive documentation about environments and deployment than just javadocs, so we're going to expand the documentation about this for 12.1.x, and I'll take care of it. Stay tuned for the updates, and your review will be appreciated. Thanks for raising this issue and PR. |
|
@byteit101 I'm closing this PR, which is now superseded by #13946. I'd appreciate your review of the new documentation added in the new PR. |
3 participants
A start for javadoc for #13534