Skip to content
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

Add Javadoc for the categories #4578

Merged
merged 1 commit into from Mar 20, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions core/src/main/java/hudson/model/ManagementLink.java
Expand Up @@ -171,12 +171,36 @@ public boolean getRequiresPOST() {
* @since TODO
*/
public enum Category {
/**
* Configuration pages that don't fit into a more specific section.
*/
CONFIGURATION(Messages._ManagementLink_Category_CONFIGURATION()),
/**
* Security related options. Useful for plugins providing security related {@code ManagementLink}s (e.g. security realms).
* Use {@link Category#STATUS} instead if the feature is informational.
*/
SECURITY(Messages._ManagementLink_Category_SECURITY()),
/**
* Status information about the Jenkins instance, such as log messages, load statistics, or general information.
*/
STATUS(Messages._ManagementLink_Category_STATUS()),
/**
* Troubleshooting utilities. This overlaps some with status information, but the difference is that status
* always applies, while troubleshooting only matters when things go wrong.
*/
TROUBLESHOOTING(Messages._ManagementLink_Category_TROUBLESHOOTING()),
/**
* Tools are specifically tools for administrators, such as the Jenkins CLI and Script Console, as well as specific stand-alone administrative features ({@link jenkins.management.ShutdownLink}, {@link jenkins.management.ReloadLink}).
* This has nothing to do with build tools or tool installers.
*/
TOOLS(Messages._ManagementLink_Category_TOOLS()),
/**
* Anything that doesn't fit into any of the other categories. Expected to be necessary only very rarely.
*/
MISC(Messages._ManagementLink_Category_MISC()),
/**
* The default category for uncategorized items. Do not explicitly specify this category for your {@code ManagementLink}.
*/
UNCATEGORIZED(Messages._ManagementLink_Category_UNCATEGORIZED());

private Localizable label;
Expand Down