You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When using the ObservableObject attribute from the CommunityToolkit.Mvvm v8.3.2 package on the code behind partial class of a WPF UserControl like this:
DocFx seems to have an issue with properly generating the code documentation for the SourceGenerators. The following warning occurs when generating the documention with DocFx v.2.77.0:
warning: InvalidCref: Invalid cref value "!:ObservableObject" found in XML documentation comment for SetProperty defined in CommunityToolkit.Mvvm.SourceGenerators\CommunityToolkit.Mvvm.SourceGenerators.ObservableObjectGenerator\DocFxTest.TestControl.g.cs Line 243.
I am aware that the proper way to handle this kind of functionality should utilize a view model. Also, ObservableObject used in view models don't have this issue with DocFx.
Feel free to have a look at my test project DocFxTest to reproduce this issue.
If this is an user issue and can be solve with a proper docfx.json configuration, please let me know.
Spec Summary:
Windows 11
CommunityToolkit.Mvvm 8.3.2
DocFx 2.77.0
Expected behavior
No warning.
The text was updated successfully, but these errors were encountered:
Confirm <see cref = "ObservableObject"/> symbol reference is not resolved (It's not highlighted)
How to fix problems
I should be referenced by using fully qualified name.
(e,g, <see cref = "global::CommunityToolkit.Mvvm.ComponentModel.ObservableObject"/>)
When using the ObservableObject attribute from the CommunityToolkit.Mvvm v8.3.2 package on the code behind partial class of a WPF UserControl like this:
DocFx seems to have an issue with properly generating the code documentation for the SourceGenerators. The following warning occurs when generating the documention with DocFx v.2.77.0:
warning: InvalidCref: Invalid cref value "!:ObservableObject" found in XML documentation comment for SetProperty defined in CommunityToolkit.Mvvm.SourceGenerators\CommunityToolkit.Mvvm.SourceGenerators.ObservableObjectGenerator\DocFxTest.TestControl.g.cs Line 243.
I am aware that the proper way to handle this kind of functionality should utilize a view model. Also, ObservableObject used in view models don't have this issue with DocFx.
Feel free to have a look at my test project DocFxTest to reproduce this issue.
If this is an user issue and can be solve with a proper docfx.json configuration, please let me know.
Spec Summary:
Expected behavior
No warning.
The text was updated successfully, but these errors were encountered: