Skip to content

Conversation

@oneolddev
Copy link
Contributor

Pull Request

πŸ“– Description

Descriptions for methods on some APIs are mssing.

🎫 Issues

Missing description from FluentGridItem.GetHiddenAttribute and ToastService

image

image

After fix

image

image

πŸ‘©β€πŸ’» Reviewer Notes

The information is in the generated CodeComments file. The key is not being generated correctly because the method is either static or one of the parameters is an EventCallback<T>.

πŸ“‘ Test Plan

I manually checked several components.

βœ… Checklist

General

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

⏭ Next Steps

@oneolddev
Copy link
Contributor Author

Examinging the CodeComments.g.cs file, you find the following:
["FluentGridItem.GetHiddenAttribute(System.Nullable{Microsoft.FluentUI.AspNetCore.Components.GridItemHidden})"] = "Returns the hidden attribute value for the specified <code>GridItemHidden</code> value.",

The key being generated also has the following: (System.Nullable{Microsoft.FluentUI.AspNetCore.Components.GridItemHidden}) which is not part of the method name.

vnbaaij
vnbaaij previously approved these changes Oct 5, 2024
@vnbaaij vnbaaij dismissed their stale review October 5, 2024 08:39

Still in draft

@oneolddev oneolddev requested a review from dvoituron October 6, 2024 19:34
@oneolddev
Copy link
Contributor Author

I got a better understanding of the xml documentation file after finding https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/#id-strings. I changed the description retrieval code to handle the name mangling of overloaded method names with generic parameters.

image

@oneolddev oneolddev marked this pull request as ready for review October 6, 2024 19:47
@vnbaaij vnbaaij added this to the V4.10.2 milestone Oct 7, 2024
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