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.

Sign up for GitHub

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

update badge documentation #8469

Merged
merged 3 commits into from
Sep 9, 2023
Merged

update badge documentation #8469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8bd38df
badge documentation
mawinter69 Sep 6, 2023
a2fbb62
fix javadoc
mawinter69 Sep 7, 2023
e991109
Merge branch 'master' into badge-doc
mawinter69 Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions core/src/main/java/jenkins/management/Badge.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@
* A badge might display the same information as an {@link AdministrativeMonitor}. While an {@link AdministrativeMonitor}
* can be disabled, a badge will always be shown. E.g. the badge of {@link OldDataMonitor.ManagementLinkImpl} always shows the number of old data entries.
*
* <p>
* A badge can also be used in a {@code <l:task .../>} to show information on the right of the link in the sidepanel,
* e.g. to show number of available plugin updates.
*
* @since 2.385
*/
@ExportedBean
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/resources/lib/layout/task.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ THE SOFTWARE.
(onclick supersedes this except in the context menu.)
(since 1.512)
</st:attribute>
<st:attribute name="badge">
<st:attribute name="badge" type="jenkins.management.Badge">
If set, displays the value as a small badge on the right side of the sidepanel item.
@since TODO
(since 2.401)
</st:attribute>
<st:attribute name="confirmationMessage">
Message to use for confirmation, if requested; defaults to title.
Expand Down