Skip to content

Document Java NIO enum options - #439

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-java-nio-file-apis
Open

Document Java NIO enum options#439
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-java-nio-file-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #210

Documents source-backed Java NIO enum-option members: AccessMode.Execute, FileVisitOption.FollowLinks, FileVisitResult.Continue, StandardCopyOption.AtomicMove and CopyAttributes, plus StandardOpenOption.Append, Create, CreateNew, DeleteOnClose, and Dsync.

Sources

Validation

  • Parsed all five modified XML files with System.Xml.XmlDocument.
  • Confirmed modified files retain CRLF-only line endings.
  • Ran git diff --check.
  • Confirmed scoped Java.Nio.FileNio placeholders changed from 416 to 396; the remaining placeholders keep issue Add XML documentation for Java.Nio.FileNio #210 open.

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 PR updates the generated XML documentation for several Java.Nio.FileNio enum-option members, replacing “To be added.” placeholders with source-backed summaries/values to improve API reference completeness (refs #210).

Changes:

  • Documented additional StandardOpenOption members: Append, Create, CreateNew, DeleteOnClose, Dsync.
  • Documented StandardCopyOption members: AtomicMove, CopyAttributes.
  • Documented enum members for traversal/access: FileVisitResult.Continue, FileVisitOption.FollowLinks, AccessMode.Execute.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/xml/Java.Nio.FileNio/StandardOpenOption.xml Replaces placeholder docs for multiple StandardOpenOption members with meaningful summaries/values.
docs/xml/Java.Nio.FileNio/StandardCopyOption.xml Adds summaries/values for AtomicMove and CopyAttributes.
docs/xml/Java.Nio.FileNio/FileVisitResult.xml Documents Continue traversal result behavior.
docs/xml/Java.Nio.FileNio/FileVisitOption.xml Documents FollowLinks traversal option.
docs/xml/Java.Nio.FileNio/AccessMode.xml Documents Execute access mode semantics.

💡 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/StandardOpenOption.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@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