Cover some of commons functionality with documentation

DEVSIX-6382

Autoported commit.
Original commit hash: [8b4d0ca]
Manual files:
commons/src/main/java/com/itextpdf/commons/actions/NamespaceConstant.java
commons/src/main/java/com/itextpdf/commons/utils/EncodingUtil.java
commons/src/main/java/com/itextpdf/commons/utils/FileUtil.java

Author: ars18wrw

itext/itext.commons/itext/commons/actions/NamespaceConstant.cs

@@ -46,6 +46,7 @@ source product.
 using iText.Commons.Utils;
 
 namespace iText.Commons.Actions {
+    /// <summary>Class that stores namespaces of iText open source products.</summary>
     public sealed class NamespaceConstant {
         public const String ITEXT = "iText";
 

itext/itext.commons/itext/commons/actions/contexts/AbstractContextManagerConfigurationEvent.cs

@@ -33,11 +33,16 @@ protected internal AbstractContextManagerConfigurationEvent()
             : base() {
         }
 
+        /// <summary>Registers generic context for products and namespaces which are associated with them.</summary>
+        /// <param name="namespaces">namespaces of the products to be registered</param>
+        /// <param name="products">the products to be registered</param>
         protected internal virtual void RegisterGenericContext(ICollection<String> namespaces, ICollection<String>
              products) {
             ContextManager.GetInstance().RegisterGenericContext(namespaces, products);
         }
 
+        /// <summary>Unregisters certain namespaces.</summary>
+        /// <param name="namespaces">the namespaces to be unregisted</param>
         protected internal virtual void UnregisterContext(ICollection<String> namespaces) {
             ContextManager.GetInstance().UnregisterContext(namespaces);
         }

itext/itext.commons/itext/commons/actions/contexts/UnknownContext.cs

@@ -65,6 +65,11 @@ public class UnknownContext : IContext {
 
         private readonly bool allowEvents;
 
+        /// <summary>
+        /// Creates a fallback
+        /// <see cref="IContext"/>.
+        /// </summary>
+        /// <param name="allowEvents">defines whether the context allows all events or not</param>
         public UnknownContext(bool allowEvents) {
             this.allowEvents = allowEvents;
         }

itext/itext.commons/itext/commons/actions/processors/AbstractITextProductEventProcessor.cs

@@ -25,9 +25,12 @@ You should have received a copy of the GNU Affero General Public License
 using iText.Commons.Exceptions;
 
 namespace iText.Commons.Actions.Processors {
+    /// <summary>Abstract class with some standard functionality for product event processing.</summary>
     public abstract class AbstractITextProductEventProcessor : ITextProductEventProcessor {
         private readonly String productName;
 
+        /// <summary>Creates a new instance of an abstract processor for the provided product.</summary>
+        /// <param name="productName">the product which will be handled by this processor</param>
         public AbstractITextProductEventProcessor(String productName) {
             if (productName == null) {
                 throw new ArgumentException(CommonsExceptionMessageConstant.PRODUCT_NAME_CAN_NOT_BE_NULL);

itext/itext.commons/itext/commons/utils/EncodingUtil.cs

@@ -61,6 +61,12 @@ static EncodingUtil() {
 
         public static Encoding ISO_8859_1 = EncodingUtil.GetEncoding("ISO-8859-1");
 
+        /// <summary>
+        /// Converts to byte array an array of chars, taking the provided encoding into account.
+        /// </summary>
+        /// <param name="chars">an array of chars to be converted to bytes</param>
+        /// <param name="encoding">the encoding to be taken into account while converting the provided array of chars</param>
+        /// <returns>the resultant array of bytes</returns>
         public static byte[] ConvertToBytes(char[] chars, String encoding) {
             Encoding encw = IanaEncodings.GetEncodingEncoding(encoding);
             byte[] preamble = encw.GetPreamble();
@@ -75,6 +81,12 @@ public static byte[] ConvertToBytes(char[] chars, String encoding) {
             }
         }
 
+        /// <summary>
+        /// Converts to String an array of bytes, taking the provided encoding into account.
+        /// </summary>
+        /// <param name="chars">an array of bytes to be converted to String</param>
+        /// <param name="encoding">the encoding to be taken into account while converting the provided bytes</param>
+        /// <returns>the resultant string</returns>
         public static String ConvertToString(byte[] bytes, String encoding) {
             if (encoding.Equals(EncodingUtil.UTF8) &&
                 bytes[0] == 0xEF && bytes[1] == 0xBB && bytes[2] == 0xBF)

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

@@ -56,25 +56,45 @@ namespace iText.Commons.Utils {
     public static class FileUtil {
         private static int tempFileCounter = 0;
 
+        /// <summary>
+        /// Gets the default windows font directory.
+        /// </summary>
+        /// <returns>the default windows font directory</returns>
         public static String GetFontsDir() {
             String windir = Environment.GetEnvironmentVariable("windir");
             return windir != null ? Path.Combine(windir, "fonts") : "";
         }
 
+        /// <summary>
+        /// Checks whether there is a file at the provided path.
+        /// </summary>
+        /// <param name="path">the path to the file to be checked on existence</param>
+        /// <returns><CODE>true</CODE> if such a file exists, otherwise <CODE>false</CODE></returns>
         public static bool FileExists(String path) {
             if (!String.IsNullOrEmpty(path)) {
                 return new FileInfo(path).Exists;
             }
             return false;
         }
 
+        /// <summary>
+        /// Checks whether there is a directory at the provided path.
+        /// </summary>
+        /// <param name="path">the path to the directory to be checked on existence</param>
+        /// <returns>true if such a directory exists, otherwise false</returns>
         public static bool DirectoryExists(String path) {
             if (!String.IsNullOrEmpty(path)) {
                 return new DirectoryInfo(path).Exists;
             }
             return false;
         }
 
+        /// <summary>
+        /// Lists all the files located at the provided directory.
+        /// </summary>
+        /// <param name="path">path to the directory</param>
+        /// <param name="recursive">if <CODE>true</CODE>, files from all the subdirectories will be returned</param>
+        /// <returns>all the files located at the provided directory</returns>
         public static String[] ListFilesInDirectory(String path, bool recursive) {
             if (!String.IsNullOrEmpty(path)) {
                 DirectoryInfo dir = new DirectoryInfo(path);
@@ -92,10 +112,23 @@ public static String[] ListFilesInDirectory(String path, bool recursive) {
             return null;
         }
 
+        /// <summary>
+        /// Lists all the files located at the provided directory, which are accepted by the provided filter.
+        /// </summary>
+        /// <param name="path">path to the directory</param>
+        /// <param name="filter">filter to accept files to be listed</param>
+        /// <returns>all the files located at the provided directory, which are accepted by the provided filter</returns>
         public static FileInfo[] ListFilesInDirectoryByFilter(String path, IFileFilter filter) {
             return ListFilesInDirectoryByFilter(path, false, filter);
         }
 
+        /// <summary>
+        /// Lists all the files located at the provided directory, which are accepted by the provided filter.
+        /// </summary>
+        /// <param name="path">path to the directory</param>
+        /// <param name="recursive">if <CODE>true</CODE>, files from all the subdirectories will be returned</param>
+        /// <param name="filter">filter to accept files to be listed</param>
+        /// <returns>all the files located at the provided directory, which are accepted by the provided filter</returns>
         public static FileInfo[] ListFilesInDirectoryByFilter(String path, bool recursive, IFileFilter filter) {
             if (!String.IsNullOrEmpty(path)) {
                 DirectoryInfo dir = new DirectoryInfo(path);
@@ -123,6 +156,12 @@ public static Stream GetBufferedOutputStream(String filename) {
             return new FileStream(filename, FileMode.Create);
         }
 
+        /// <summary>
+        /// Creates a temporary file at the provided path.
+        /// </summary>
+        /// <param name="path">path to the temporary file to be created. If it is a directory,
+        /// then the temporary file will be created at this directory</param>
+        /// <returns>the created temporary file</returns>
         public static FileInfo CreateTempFile(String path) {
             if (DirectoryExists(path)) {
                 return new FileInfo(path + Path.DirectorySeparatorChar + "pdf_" + Interlocked.Increment(ref tempFileCounter));
@@ -148,6 +187,10 @@ public static Stream WrapWithBufferedOutputStream(Stream outputStream)
             return outputStream;
         }
 
+        /// <summary>
+        /// Creates a directory at the provided path.
+        /// </summary>
+        /// <param name="outPath">path to the directory to be created</param>
         public static void CreateDirectories(String outPath) {
             Directory.CreateDirectory(outPath);
         }

port-hash

@@ -1 +1 @@
-0f3f55f35ec6f902330696262c7237135d44bf86
+8b4d0ca65f67858c609e5ee542119afff3329d51