Skip to content

CLIEvent events are considered properties in XmlDoc Ids and Symbol API #10273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
auduchinok opened this issue Oct 19, 2020 · 0 comments · May be fixed by #18584
Open

CLIEvent events are considered properties in XmlDoc Ids and Symbol API #10273

auduchinok opened this issue Oct 19, 2020 · 0 comments · May be fixed by #18584
Assignees
@Copilot
Labels
Area-XmlDocs xmldoc generation, xmldoc content Bug Impact-Medium (Internal MS Team use only) Describes an issue with moderate impact on existing code.
Milestone
Backlog

Comments

@auduchinok
Copy link
Member

auduchinok commented Oct 19, 2020 •
edited
Loading

F# properties tagged with CLIEvent attribute are compiled to CLI events instead of properties, however XmlDoc id mentions such events as properties anyway:

type T() =
    /// An event.
    [<CLIEvent>]
    member x.E = Event<int>().Publish

Generated documentation file:

<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly><name>ConsoleApp1</name></assembly>
<members>
<member name="M:Program.T.remove_E(Microsoft.FSharp.Control.FSharpHandler{System.Int32})">
<summary>
 An event.
</summary>
</member>
<member name="P:Program.T.E">
<summary>
 An event.
</summary>
</member>
<member name="M:Program.T.add_E(Microsoft.FSharp.Control.FSharpHandler{System.Int32})">
<summary>
 An event.
</summary>
</member>
</members>
</doc>

FCS Symbol API also reports the wrong id in FSharpMemberOrFunctionOrValue.XmlDocSig, and IsEvent is also false.

Probably related: #5834.
@auduchinok auduchinok changed the title CLIEvent events are considered properties in XmlDoc Ids CLIEvent events are considered properties in XmlDoc Ids and Symbol API Oct 19, 2020
@cartermp cartermp added Area-Compiler Bug Impact-Low (Internal MS Team use only) Describes an issue with limited impact on existing code. Impact-Medium (Internal MS Team use only) Describes an issue with moderate impact on existing code. and removed Impact-Low (Internal MS Team use only) Describes an issue with limited impact on existing code. labels Oct 19, 2020
@cartermp cartermp added this to the Backlog milestone Oct 19, 2020
@dsyme dsyme added Area-XmlDocs xmldoc generation, xmldoc content and removed Area-Compiler labels Apr 4, 2022
@vzarytovskii vzarytovskii moved this to Not Planned in F# Compiler and Tooling Jun 17, 2022
@Copilot Copilot AI linked a pull request May 21, 2025 that will close this issue
Draft
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

Copilot code review Copilot

Labels
Area-XmlDocs xmldoc generation, xmldoc content Bug Impact-Medium (Internal MS Team use only) Describes an issue with moderate impact on existing code.
Projects
F# Compiler and Tooling
Status: New
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

[WIP] CLIEvent events are considered properties in XmlDoc Ids and Symbol API dotnet/fsharp
3 participants
@auduchinok @cartermp @dsyme