documentation

Author: infeo

src/main/java/dev/dokan/dokan_java/AbstractDokanyFileSystem.java

@@ -21,6 +21,9 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.stream.Collectors;
 
+/**
+ * TODO: Add Description to this class
+ */
 public abstract class AbstractDokanyFileSystem implements DokanyFileSystem {
 
     private static final int TIMEOUT = 3000;

src/main/java/dev/dokan/dokan_java/DokanyFileSystemStub.java

@@ -14,6 +14,19 @@ public DokanyFileSystemStub(FileSystemInformation fileSystemInformation, boolean
         super(fileSystemInformation, usesKernelFlagsAndCodes);
     }
 
+    /**
+     * {@inheritDoc}
+     *
+     * <p>
+     * <b>Remark:</b>
+     * When your filesystem uses the win32 codes (i.e. setting usesKernelFlagsAndCodes to false), some of the parameters are different form the description:
+     * </p>
+     * <ol>
+     *     <li>rawDesiredAccess represents the generic access mask of {@link dev.dokan.dokan_java.constants.microsoft.AccessMask} with specific one</li>
+     *     <li>rawFileAttributes contains besides the file attributes also file flags (see <a href=https://docs.microsoft.com/de-de/windows/win32/api/fileapi/nf-fileapi-createfilea>Microsoft documentation of CreateFile</a>) </li>
+     *     <li>rawCreateDisposition represents an {@link dev.dokan.dokan_java.constants.microsoft.CreationDisposition} value</li>
+     * </ol>
+     */
     @Override
     @NotImplemented
     public int zwCreateFile(WString rawPath, WinBase.SECURITY_ATTRIBUTES securityContext, int rawDesiredAccess, int rawFileAttributes, int rawShareAccess, int rawCreateDisposition, int rawCreateOptions, DokanFileInfo dokanFileInfo) {

src/main/java/dev/dokan/dokan_java/constants/microsoft/FileAttribute.java

@@ -5,7 +5,7 @@
 import com.sun.jna.platform.win32.WinNT;
 
 /**
- * File attributes flags. They are  metadata values stored by the file system on disk and are used by the system.
+ * File attribute flags. They are  metadata values stored by the file system on disk and are used by the system.
  *
  * @see <a href="https://docs.microsoft.com/en-us/windows/desktop/FileIO/file-attribute-constants">Microsoft documentation of file attribute constants</a>
  * @see <a href="https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-createfilea">Microsoft documentation of CreateFileA function including the list of valid file attributes</a>