Skip to content

Document FileStore space properties - #459

Open
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-java-nio-file-docs
Open

Document FileStore space properties#459
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-java-nio-file-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #210

Documents source-backed Java.Nio.FileNio.FileStore availability and capacity properties: IsReadOnly, TotalSpace, UnallocatedSpace, and UsableSpace.

Sources

Validation

  • Parsed docs/xml/Java.Nio.FileNio/FileStore.xml with System.Xml.XmlDocument.
  • Confirmed the modified file retains CRLF-only line endings.
  • Ran git diff --check.
  • Confirmed FileStore.xml placeholders changed from 17 to 9.

Refs #210

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 improves the generated XML documentation for Java.Nio.FileNio.FileStore by replacing “To be added.” placeholders with meaningful descriptions for storage capacity/availability properties, aligning the docs with the referenced Android/Java documentation.

Changes:

  • Documented IsReadOnly with clearer semantics and an Android reference link.
  • Documented TotalSpace, UnallocatedSpace, and UsableSpace (including long.MaxValue overflow behavior) with Android reference links.
  • Added additional remarks for the “hint, not a guarantee” semantics on space-related properties.

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

@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The three documented space properties omit part of their public failure contract:

  • docs/xml/Java.Nio.FileNio/FileStore.xml: TotalSpace, UnallocatedSpace, and UsableSpace can each throw Java.IO.IOException, but none of the property docs include that exception. Please add the exception documentation to all three properties so callers are not told an incomplete contract.

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.

3 participants