Skip to content

Commit ea7a0c3

Browse files
BlackEgoistiText-CI
authored andcommitted
Fix javadoc warnings
DEVSIX-4161 Autoported commit. Original commit hash: [96fadd774]
1 parent 48df2b5 commit ea7a0c3

File tree

2 files changed

+90
-7
lines changed

2 files changed

+90
-7
lines changed

itext/itext.forms/itext/forms/xfdf/ActionObject.cs

Lines changed: 89 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,11 @@ public ActionObject(PdfName type) {
120120
/// ,
121121
/// <see cref="iText.Kernel.Pdf.PdfName.Named"/>.
122122
/// </remarks>
123+
/// <returns>
124+
///
125+
/// <see cref="iText.Kernel.Pdf.PdfName"/>
126+
/// type of inner action element
127+
/// </returns>
123128
public virtual PdfName GetType() {
124129
return type;
125130
}
@@ -137,6 +142,15 @@ public virtual PdfName GetType() {
137142
/// ,
138143
/// <see cref="iText.Kernel.Pdf.PdfName.Named"/>.
139144
/// </remarks>
145+
/// <param name="type">
146+
///
147+
/// <see cref="iText.Kernel.Pdf.PdfName"/>
148+
/// type of inner action object
149+
/// </param>
150+
/// <returns>
151+
/// current
152+
/// <see cref="ActionObject"/>
153+
/// </returns>
140154
public virtual iText.Forms.Xfdf.ActionObject SetType(PdfName type) {
141155
this.type = type;
142156
return this;
@@ -147,15 +161,29 @@ public virtual iText.Forms.Xfdf.ActionObject SetType(PdfName type) {
147161
/// Gets the string value of URI elements. Corresponds to Name, required attribute of URI element.
148162
/// For more details see paragraph 6.5.30 in Xfdf specification.
149163
/// </remarks>
164+
/// <returns>
165+
///
166+
/// <see cref="iText.Kernel.Pdf.PdfString"/>
167+
/// value of URI element
168+
/// </returns>
150169
public virtual PdfString GetUri() {
151170
return uri;
152171
}
153172

154-
/// <summary>Sets the string value of URI elements.</summary>
173+
/// <summary>Sets the string value of URI element.</summary>
155174
/// <remarks>
156-
/// Sets the string value of URI elements. Corresponds to Name, required attribute of URI element.
175+
/// Sets the string value of URI element. Corresponds to Name, required attribute of URI element.
157176
/// For more details see paragraph 6.5.30 in Xfdf specification.
158177
/// </remarks>
178+
/// <param name="uri">
179+
///
180+
/// <see cref="iText.Kernel.Pdf.PdfString"/>
181+
/// value to be set to URI element
182+
/// </param>
183+
/// <returns>
184+
/// current
185+
/// <see cref="ActionObject"/>
186+
/// </returns>
159187
public virtual iText.Forms.Xfdf.ActionObject SetUri(PdfString uri) {
160188
this.uri = uri;
161189
return this;
@@ -164,13 +192,19 @@ public virtual iText.Forms.Xfdf.ActionObject SetUri(PdfString uri) {
164192
/// <summary>Gets IsMap, optional attribute of URI element.</summary>
165193
/// <remarks>Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
166194
/// </remarks>
195+
/// <returns>boolean indicating if URI element is a map</returns>
167196
public virtual bool IsMap() {
168197
return isMap;
169198
}
170199

171200
/// <summary>Sets IsMap, optional attribute of URI element.</summary>
172201
/// <remarks>Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
173202
/// </remarks>
203+
/// <param name="map">boolean indicating if URI element is a map</param>
204+
/// <returns>
205+
/// current
206+
/// <see cref="ActionObject"/>
207+
/// </returns>
174208
public virtual iText.Forms.Xfdf.ActionObject SetMap(bool map) {
175209
isMap = map;
176210
return this;
@@ -179,13 +213,27 @@ public virtual iText.Forms.Xfdf.ActionObject SetMap(bool map) {
179213
/// <summary>Gets the value of Name, required attribute of Named element.</summary>
180214
/// <remarks>Gets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
181215
/// </remarks>
216+
/// <returns>
217+
///
218+
/// <see cref="iText.Kernel.Pdf.PdfName"/>
219+
/// value of Name attribute of a named action element
220+
/// </returns>
182221
public virtual PdfName GetNameAction() {
183222
return nameAction;
184223
}
185224

186225
/// <summary>Sets the value of Name, required attribute of Named element.</summary>
187226
/// <remarks>Sets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
188227
/// </remarks>
228+
/// <param name="nameAction">
229+
///
230+
/// <see cref="iText.Kernel.Pdf.PdfName"/>
231+
/// value to be set to Name attribute of a named action element
232+
/// </param>
233+
/// <returns>
234+
/// current
235+
/// <see cref="ActionObject"/>
236+
/// </returns>
189237
public virtual iText.Forms.Xfdf.ActionObject SetNameAction(PdfName nameAction) {
190238
this.nameAction = nameAction;
191239
return this;
@@ -198,6 +246,11 @@ public virtual iText.Forms.Xfdf.ActionObject SetNameAction(PdfName nameAction) {
198246
/// Corresponds to F key in go-to action or launch dictionaries.
199247
/// For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
200248
/// </remarks>
249+
/// <returns>
250+
///
251+
/// <see cref="System.String"/>
252+
/// value of OriginalName attribute of current action object
253+
/// </returns>
201254
public virtual String GetFileOriginalName() {
202255
return fileOriginalName;
203256
}
@@ -209,21 +262,37 @@ public virtual String GetFileOriginalName() {
209262
/// Corresponds to F key in go-to action or launch dictionaries.
210263
/// For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
211264
/// </remarks>
265+
/// <param name="fileOriginalName">
266+
///
267+
/// <see cref="System.String"/>
268+
/// value of OriginalName attribute of action object
269+
/// </param>
270+
/// <returns>
271+
/// current
272+
/// <see cref="ActionObject"/>
273+
/// </returns>
212274
public virtual iText.Forms.Xfdf.ActionObject SetFileOriginalName(String fileOriginalName) {
213275
this.fileOriginalName = fileOriginalName;
214276
return this;
215277
}
216278

217-
/// <summary>Sets the boolean value of NewWindow, optional attribute of Launch element.</summary>
218-
/// <remarks>Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
279+
/// <summary>Gets the boolean value of NewWindow, optional attribute of Launch element.</summary>
280+
/// <remarks>Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
219281
/// </remarks>
282+
/// <returns>boolean indicating if current Launch action element should be opened in a new window</returns>
220283
public virtual bool IsNewWindow() {
221284
return isNewWindow;
222285
}
223286

224-
/// <summary>Gets the boolean value of NewWindow, optional attribute of Launch element.</summary>
225-
/// <remarks>Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
287+
/// <summary>Sets the boolean value of NewWindow, optional attribute of Launch element.</summary>
288+
/// <remarks>Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
226289
/// </remarks>
290+
/// <param name="newWindow">boolean indicating if current Launch action element should be opened in a new window
291+
/// </param>
292+
/// <returns>
293+
/// current
294+
/// <see cref="ActionObject"/>
295+
/// </returns>
227296
public virtual iText.Forms.Xfdf.ActionObject SetNewWindow(bool newWindow) {
228297
isNewWindow = newWindow;
229298
return this;
@@ -235,6 +304,11 @@ public virtual iText.Forms.Xfdf.ActionObject SetNewWindow(bool newWindow) {
235304
/// Corresponds to Dest key in link annotation dictionary.
236305
/// For more details see paragraph 6.5.10 in Xfdf specification.
237306
/// </remarks>
307+
/// <returns>
308+
///
309+
/// <see cref="DestObject"/>
310+
/// destination attribute of current action element
311+
/// </returns>
238312
public virtual DestObject GetDestination() {
239313
return destination;
240314
}
@@ -245,6 +319,15 @@ public virtual DestObject GetDestination() {
245319
/// Corresponds to Dest key in link annotation dictionary.
246320
/// For more details see paragraph 6.5.10 in Xfdf specification.
247321
/// </remarks>
322+
/// <param name="destination">
323+
///
324+
/// <see cref="DestObject"/>
325+
/// destination attribute of the action element
326+
/// </param>
327+
/// <returns>
328+
/// current
329+
/// <see cref="ActionObject"/>
330+
/// </returns>
248331
public virtual iText.Forms.Xfdf.ActionObject SetDestination(DestObject destination) {
249332
this.destination = destination;
250333
return this;

port-hash

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
9643dcd905936eeb99cd34ab3be188f7f30a3d24
1+
96fadd774f1f5ff540d5e92f318a062064655241

0 commit comments

Comments
 (0)