PollingFileChangeToken.ActiveChangeCallbacks says it is always false but can be true

[yaakov-h]

Description

PollingFileChangeToken.ActiveChangeCallbacks is documented to be "Always false.", but it can be set to true by PhysicalFilesWatcher here:

https://github.com/dotnet/runtime/blob/2201016c1e13bdb9abf49e2e38cadf4ee0568df2/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs#L195

The issue seems to have been introduced here when an internal setter was added without updating the xmldoc:

dotnet/runtime@f5c09c2#diff-f0404a6e281b49fe956eb63b7133b6d334f155f04173ec3c6b333b4fcb9948b7

Reproduction Steps

Look at the xmldoc or the Microsoft docs here:

https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.fileproviders.physical.pollingfilechangetoken.activechangecallbacks?view=dotnet-plat-ext-6.0#microsoft-extensions-fileproviders-physical-pollingfilechangetoken-activechangecallbacks

Expected behavior

A mutable property is not documented to be in always a singular state.

Actual behavior

A boolean property with a (internal) setter is documented to be "always false".

Regression?

No response

Known Workarounds

No response

Configuration

No response

Other information

No response

Tagging subscribers to this area: @dotnet/area-extensions-filesystem
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Description

PollingFileChangeToken.ActiveChangeCallbacks is documented to be "Always false.", but it can be set to true by PhysicalFilesWatcher here:

https://github.com/dotnet/runtime/blob/2201016c1e13bdb9abf49e2e38cadf4ee0568df2/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs#L195

The issue seems to have been introduced here when an internal setter was added without updating the xmldoc:

dotnet/runtime@f5c09c2#diff-f0404a6e281b49fe956eb63b7133b6d334f155f04173ec3c6b333b4fcb9948b7

Reproduction Steps

Look at the xmldoc or the Microsoft docs here:

https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.fileproviders.physical.pollingfilechangetoken.activechangecallbacks?view=dotnet-plat-ext-6.0#microsoft-extensions-fileproviders-physical-pollingfilechangetoken-activechangecallbacks

Expected behavior

A mutable property is not documented to be in always a singular state.

Actual behavior

A boolean property with a (internal) setter is documented to be "always false".

Regression?

No response

Known Workarounds

No response

Configuration

No response

Other information

No response

Author:	yaakov-h
Assignees:	-
Labels:	area-Extensions-FileSystem
Milestone:	-