|
75 | 75 | import java.util.TreeMap; |
76 | 76 |
|
77 | 77 | /** |
78 | | - * A swing component with a circular progress bar displaying the overall progress of all registered |
79 | | - * {@link Task} created via the {@link org.scijava.task.TaskService} |
80 | | - * |
81 | | - * When the user clicks on the circular progress bar, a frame containing a table summarizing each task progression |
82 | | - * is displayed |
83 | | - * |
84 | | - * Each task is rendered in the table with a custom renderer (see {@link TaskRenderer}): |
85 | | - * First column: |
86 | | - * - a label with the name of the task and its status |
87 | | - * - a linear progress bar |
88 | | - * - if enabled in the constructor, a label with an estimation of the remaining time until task completion, |
89 | | - * the estimation assumes a constant completion speed since the start of the task registration |
90 | | - * |
| 78 | + * A Swing component with a circular progress bar displaying the overall |
| 79 | + * progress of all registered {@link Task} created via the |
| 80 | + * {@link org.scijava.task.TaskService}. |
| 81 | + * <p> |
| 82 | + * When the user clicks on the circular progress bar, a frame containing a table |
| 83 | + * summarizing each task progression is displayed. |
| 84 | + * </p> |
| 85 | + * <p> |
| 86 | + * Each task is rendered in the table with a custom renderer (see |
| 87 | + * {@link TaskRenderer}). First column: |
| 88 | + * </p> |
| 89 | + * <ul> |
| 90 | + * <li>a label with the name of the task and its status</li> |
| 91 | + * <li>a linear progress bar</li> |
| 92 | + * <li>if enabled in the constructor, a label with an estimation of the |
| 93 | + * remaining time until task completion, the estimation assumes a constant |
| 94 | + * completion speed since the start of the task registration</li> |
| 95 | + * </ul> |
| 96 | + * <p> |
91 | 97 | * Second column: |
92 | | - * - a stop icon, clickable and which calls {@link Task#cancel(String)} for the displayed task |
93 | | - * Before cancellation, a user confirmation dialog can be enabled |
94 | | - * with {@link SwingTaskMonitorComponent#enableCancelConfirmation()} or disabled with |
95 | | - * {@link SwingTaskMonitorComponent#disableCancelConfirmation()} |
| 98 | + * </p> |
| 99 | + * <ul> |
| 100 | + * <li>a stop icon, clickable and which calls {@link Task#cancel(String)} for |
| 101 | + * the displayed task</li> |
| 102 | + * </ul> |
| 103 | + * <p> |
| 104 | + * Before cancellation, a user confirmation dialog can be enabled with |
| 105 | + * {@link SwingTaskMonitorComponent#enableCancelConfirmation()} or disabled with |
| 106 | + * {@link SwingTaskMonitorComponent#disableCancelConfirmation()}. |
| 107 | + * </p> |
96 | 108 | * |
97 | 109 | * @author Nicolas Chiaruttini, EPFL, 2022 |
98 | 110 | */ |
|
0 commit comments