Update progressiveText.jelly with documentation tag (#10085)

jenkinsci · Dec 24, 2024 · 76fa2e5 · 76fa2e5
1 parent cb51ae3
commit 76fa2e5
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 24 deletions.
diff --git a/core/src/main/resources/lib/hudson/buildHealth.jelly b/core/src/main/resources/lib/hudson/buildHealth.jelly
@@ -22,15 +22,14 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 -->
 
-<!--
-  <%@ attribute name="job" use="required" type="hudson.model.Job" %>
-  <%@ attribute name="iconSizeClass" type="java.lang.String" %>
-  <%@ attribute name="iconSize" type="java.lang.String" %>
-  <%@ attribute name="td" required="false" type="java.lang.String" %>
-  <%@ attribute name="link" required="false" type="java.lang.String" %>
--->
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:x="jelly:xml" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+  <st:documentation>
+    <st:attribute name="job" use="required" type="hudson.model.Job">Job to display the health report.</st:attribute>
+    <st:attribute name="td" type="java.lang.Boolean">If `td` should be used instead of `div` to wrap the health reports.</st:attribute>
+    <st:attribute name="link" type="java.lang.String">href of the link.</st:attribute>
+    <st:attribute name="style" type="java.lang.String">link style.</st:attribute>
+  </st:documentation>
   <j:set var="healthReports" value="${job.buildHealthReports}"/>
   <j:new var="emptyHealthReport" className="hudson.model.HealthReport"/>
   <j:set var="buildHealth" value="${empty(healthReports) ? emptyHealthReport : healthReports[0]}"/>

diff --git a/core/src/main/resources/lib/hudson/buildRangeLink.jelly b/core/src/main/resources/lib/hudson/buildRangeLink.jelly
@@ -22,15 +22,14 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 -->
 
-<!--
-  Link to a range of build. Used by fingerprint/index.jsp
-
-	<%@ attribute name="range" type="java.lang.Object" use="required" %>
-	<%@ attribute name="job" type="hudson.model.Job" use="required" %>
--->
 <!-- it's hudson.model.Fingerprint.RangeSet but Tomcat can't seem to handler inner classes -->
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+	<st:documentation>
+		Link to a range of build. Used by fingerprint/index.jelly
+		<st:attribute name="range" type="hudson.model.Fingerprint.RangeSet" use="required">A range set of builds</st:attribute>
+		<st:attribute name="job" type="hudson.model.Job" use="required">The owner of the builds</st:attribute>
+	</st:documentation>
 	<j:forEach var="r" items="${range.ranges}">
 	  <j:choose>
 	    <j:when test="${r.start==r.end-1}">

diff --git a/core/src/main/resources/lib/hudson/progressiveText.jelly b/core/src/main/resources/lib/hudson/progressiveText.jelly
@@ -22,19 +22,18 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 -->
 
-<!--
-  Use AJAX to load text data progressively.
-  This is used to achieve the effect of "tail -f"
-  without relying on full page reload.
-
-	<%@attribute name="href" use="required" description="URL that returns text data" %>
-	<%@attribute name="idref" use="required" description="ID of the HTML element in which the result is displayed" %>
-	<%@attribute name="spinner" required="false" description="ID of the HTML element in which the spinner is displayed" %>
-	<%@attribute name="startOffset" required="false" description="Skip this many bytes rather than showing from start of data" %>
-	<%@attribute name="onFinishEvent" required="false" description="JS custom event to be fired when progress is finished" %>
--->
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+  <st:documentation>
+    Use AJAX to load text data progressively.
+    This is used to achieve the effect of "tail -f"
+    without relying on full page reload.
+    <st:attribute name="href" use="required">URL that returns text data</st:attribute>
+    <st:attribute name="idref" use="required">ID of the HTML element in which the result is displayed</st:attribute>
+    <st:attribute name="spinner">ID of the HTML element in which the spinner is displayed</st:attribute>
+    <st:attribute name="startOffset">Skip this many bytes rather than showing from start of data</st:attribute>
+    <st:attribute name="onFinishEvent">JS custom event to be fired when progress is finished</st:attribute>
+  </st:documentation>
   <div class="progressiveText-holder" data-href="${href}" data-idref="${idref}" data-spinner="${spinner}" data-start-offset="${startOffset}"
        data-on-finish-event="${empty(onFinishEvent) ? '' : onFinishEvent}"
        data-error-message="${%errorMessage}"/>