Skip to content

Document Java NIO file attributes - #579

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-nio-attributes
Open

Document Java NIO file attributes#579
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-nio-attributes

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Document the Java NIO file-attribute namespace and its 204 previously undocumented scoped XML entries.
  • Use Android/Java semantics for file attribute, ACL, POSIX, DOS, and principal APIs, with managed binding-runtime documentation where applicable.

Sources

Validation

  • Parsed all 26 scoped XML files successfully.
  • Confirmed CRLF line endings for all scoped XML files.
  • Confirmed scoped To be added. placeholders changed from 204 to 0.
  • Ran git diff --check and verified every changed path is within the issue scope.

Refs #190

Refs #190

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request updates the XML reference documentation for the Java.Nio.FileNio.Attributes namespace, replacing previously-placeholder content with Android/Java-aligned API documentation and binding-runtime notes.

Changes:

  • Added namespace-level summary/remarks for Java.Nio.FileNio.Attributes, including links and attribution.
  • Replaced many To be added. placeholders with meaningful summaries/values/returns across file attribute views, enums, and supporting types.
  • Updated binding-runtime-related documentation text for JNI peer metadata and threshold properties/constructors.

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 19 comments.

Show a summary per file
File Description
docs/xml/ns-Java.Nio.FileNio.Attributes.xml Adds namespace summary/remarks and references.
docs/xml/Java.Nio.FileNio.Attributes/UserPrincipalNotFoundException.xml Replaces placeholders with runtime/JNI constructor and property docs.
docs/xml/Java.Nio.FileNio.Attributes/UserPrincipalLookupService.xml Updates constructor/property docs; removes placeholders across members.
docs/xml/Java.Nio.FileNio.Attributes/PosixFilePermissions.xml Documents binding/runtime properties.
docs/xml/Java.Nio.FileNio.Attributes/PosixFilePermission.xml Documents enum members plus binding/runtime properties and methods.
docs/xml/Java.Nio.FileNio.Attributes/IUserDefinedFileAttributeView.xml Improves returns documentation for view name.
docs/xml/Java.Nio.FileNio.Attributes/IPosixFileAttributeView.xml Improves view-name return docs and bulk-read method docs.
docs/xml/Java.Nio.FileNio.Attributes/IFileOwnerAttributeView.xml Improves view-name return docs and Owner property docs.
docs/xml/Java.Nio.FileNio.Attributes/IDosFileAttributeView.xml Improves view-name return docs and bulk-read method docs.
docs/xml/Java.Nio.FileNio.Attributes/IDosFileAttributes.xml Documents DOS attribute boolean properties.
docs/xml/Java.Nio.FileNio.Attributes/IBasicFileAttributeView.xml Improves view-name return docs.
docs/xml/Java.Nio.FileNio.Attributes/IBasicFileAttributes.xml Documents basic file attribute boolean properties.
docs/xml/Java.Nio.FileNio.Attributes/IAclFileAttributeView.xml Documents ACL property and view-name return docs.
docs/xml/Java.Nio.FileNio.Attributes/FileTime.xml Documents compare semantics and binding/runtime properties.
docs/xml/Java.Nio.FileNio.Attributes/AclEntryType.xml Documents enum values plus binding/runtime properties.
docs/xml/Java.Nio.FileNio.Attributes/AclEntryPermission.xml Documents permission values plus binding/runtime properties.
docs/xml/Java.Nio.FileNio.Attributes/AclEntryFlag.xml Documents flag values plus binding/runtime properties.
docs/xml/Java.Nio.FileNio.Attributes/AclEntry+Builder.xml Documents builder methods and binding/runtime properties.
docs/xml/Java.Nio.FileNio.Attributes/AclEntry.xml Documents entry members and binding/runtime properties.
Suppressed comments (20)

docs/xml/Java.Nio.FileNio.Attributes/UserPrincipalNotFoundException.xml:211

  • This property documentation removed the element. For properties, keep a description so generated docs include value information (and stay consistent with other binding-runtime properties).
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/UserPrincipalNotFoundException.xml:241

  • This property documentation removed the element. For properties, keep a description so generated docs include value information (and stay consistent with other binding-runtime properties).
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/UserPrincipalLookupService.xml:251

  • This property documentation removed the element. For properties, keep a description so generated docs include value information (and stay consistent with other binding-runtime properties).
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/UserPrincipalLookupService.xml:281

  • This property documentation removed the element. For properties, keep a description so generated docs include value information (and stay consistent with other binding-runtime properties).
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/PosixFilePermissions.xml:228

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/PosixFilePermissions.xml:258

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/PosixFilePermission.xml:387

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/PosixFilePermission.xml:421

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/FileTime.xml:343

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/FileTime.xml:373

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntryType.xml:228

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntryType.xml:262

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntryFlag.xml:231

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntryFlag.xml:265

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntry+Builder.xml:398

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntry+Builder.xml:432

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntryPermission.xml:508

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntry.xml:356

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntry.xml:386

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

docs/xml/Java.Nio.FileNio.Attributes/AclEntryPermission.xml:542

  • This property documentation removed the element. Adding a keeps the property documentation complete and consistent with other binding-runtime properties.
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Java.Nio.FileNio.Attributes/IUserDefinedFileAttributeView.xml Outdated
Comment thread docs/xml/Java.Nio.FileNio.Attributes/IBasicFileAttributeView.xml Outdated
Comment thread docs/xml/Java.Nio.FileNio.Attributes/IPosixFileAttributeView.xml Outdated
Comment thread docs/xml/Java.Nio.FileNio.Attributes/IDosFileAttributeView.xml Outdated
Comment thread docs/xml/Java.Nio.FileNio.Attributes/IAclFileAttributeView.xml Outdated
Comment thread docs/xml/Java.Nio.FileNio.Attributes/AclEntryType.xml
Comment thread docs/xml/Java.Nio.FileNio.Attributes/AclEntryFlag.xml
Comment thread docs/xml/Java.Nio.FileNio.Attributes/AclEntry+Builder.xml
Comment thread docs/xml/Java.Nio.FileNio.Attributes/AclEntryPermission.xml
Comment thread docs/xml/Java.Nio.FileNio.Attributes/AclEntry.xml
Refs #190

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 15, 2026 17:01
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants