Skip to content

[BUG] Remove the requirement for the XML comments on all publicly visible methods. #55606

@nick863

Description

@nick863

Library name and version

Engineering system

Describe the bug

Related to comment
We need to keep the CS1591 suppression because otherwise all the custom methods will require separate XML comments.

Expected behavior

Introduction of a new method should not result into error,

Actual behavior

Adding a new method results in multiple errors like
C:\Users\nirovins\eclipse-workspace\azure-sdk-for-net\sdk\ai\Azure.AI.Projects.OpenAI\src\Custom\PromptAgentDefinition.cs(30,57): error CS1591: Missing XML comment for publicly visible type or member 'PromptAgentDefinition.TextOptions'
C:\Users\nirovins\eclipse-workspace\azure-sdk-for-net\sdk\ai\Azure.AI.Projects.OpenAI\src\Custom\ResponseItemExtensions.cs(12,29): error CS1591: Missing XML comment for publicly visible type or member 'ResponseItemExtensions'
C:\Users\nirovins\eclipse-workspace\azure-sdk-for-net\sdk\ai\Azure.AI.Projects.OpenAI\src\Custom\ResponseItemExtensions.cs(14,37): error CS1591: Missing XML comment for publicly visible type or member 'ResponseItemExtensions.AsAgentResponseItem(ResponseItem)'

Reproduction Steps

  • Generate a code from typespec.
  • Override one of the methods
  • Observe the errors.

Environment

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    AI ProjectsClientThis issue is related to a non-management package

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions