Skip to content

Commit a1377ef

Browse files
Eugene Bochiloyulian-gaponenko
authored andcommitted
Fix errors while generating javadocs
DEVSIX-5807 Autoported commit. Original commit hash: [9fd916e79] Manual files: commons/src/main/java/com/itextpdf/commons/utils/FileUtil.java
1 parent 5d04dec commit a1377ef

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

itext/itext.commons/itext/commons/actions/AbstractStatisticsEvent.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@ public abstract class AbstractStatisticsEvent : AbstractProductITextEvent {
3535
private static readonly ILogger LOGGER = ITextLogManager.GetLogger(typeof(iText.Commons.Actions.AbstractStatisticsEvent
3636
));
3737

38-
/// <seealso cref="AbstractProductITextEvent.AbstractProductITextEvent(iText.Commons.Actions.Data.ProductData)
39-
/// "/>
38+
/// <summary>Creates instance of abstract statistics iText event based on passed product data.</summary>
39+
/// <remarks>Creates instance of abstract statistics iText event based on passed product data. Only for internal usage.
40+
/// </remarks>
41+
/// <param name="productData">is a description of the product which has generated an event</param>
4042
protected internal AbstractStatisticsEvent(ProductData productData)
4143
: base(productData) {
4244
}
@@ -49,7 +51,7 @@ protected internal AbstractStatisticsEvent(ProductData productData)
4951
/// <param name="statisticsName">
5052
/// name of statistics based on which aggregator will be created.
5153
/// Shall be one of those returned from
52-
/// <see>this#getStatisticsNames()</see>
54+
/// <see cref="GetStatisticsNames()"/>
5355
/// </param>
5456
/// <returns>
5557
/// new instance of

itext/itext.commons/itext/commons/utils/FileUtil.cs

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,15 @@ public static String GetBaseDirectory() {
164164
return AppDomain.CurrentDomain.BaseDirectory;
165165
}
166166

167+
/// <summary>
167168
/// Deletes a file and returns whether the operation succeeded.
168-
/// Node that only *files* are supported, not directories.
169+
/// </summary>
170+
/// <remarks>
171+
/// Deletes a file and returns whether the operation succeeded.
172+
/// Note that only *files* are supported, not directories.
173+
/// </remarks>
174+
/// <param name="file">file to be deleted</param>
175+
/// <returns>true if file was deleted successfully, false otherwise</returns>
169176
public static bool DeleteFile(FileInfo file) {
170177
try {
171178
file.Delete();
@@ -175,6 +182,11 @@ public static bool DeleteFile(FileInfo file) {
175182
}
176183
}
177184

185+
/// <summary>
186+
/// Returns an URL of the parent directory for the resource.
187+
/// </summary>
188+
/// <param name="url">of resource</param>
189+
/// <returns>parent directory path| the same path if a catalog`s url is passed;</returns>
178190
public static String ParentDirectory(Uri url) {
179191
return new Uri(url, ".").ToString();
180192
}

0 commit comments

Comments
 (0)