docs: add javadoc for return value

ctron · ctron · commit 5c3df005ce6f · 2022-08-17T09:30:58.000+02:00
diff --git a/rpm/src/main/java/org/eclipse/packager/rpm/build/PayloadProvider.java b/rpm/src/main/java/org/eclipse/packager/rpm/build/PayloadProvider.java
@@ -81,6 +81,8 @@ public interface PayloadProvider
      * Get additional header tags.
      * <p>
      * An implementation must always return a new instance, but also every call must provide the same content.
+     *
+     * @return A new instance with the additional header entries. Possibly empty, but never {@code null}.
      */
     default Header<RpmTag> getAdditionalHeader ()
     {

Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,8 @@ public interface PayloadProvider`
`81`	`81`	`* Get additional header tags.`
`82`	`82`	`* <p>`
`83`	`83`	`* An implementation must always return a new instance, but also every call must provide the same content.`
	`84`	`+ *`
	`85`	`+ * @return A new instance with the additional header entries. Possibly empty, but never {@code null}.`
`84`	`86`	`*/`
`85`	`87`	`default Header<RpmTag> getAdditionalHeader ()`
`86`	`88`	`{`