Skip to content

[Chore]: Add XML comments for visible types or members #733

@Dor-bl

Description

@Dor-bl

Many Complier Warnings CS1591 are found in the project.
Any assistance with those would be great!
https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs1591?f1url=%3FappId%3Droslyn%26k%3Dk(CS1591)
image

some examples:

src\Appium.Net\Appium\Interfaces\IHidesKeyboard.cs(42,33): Warning CS1584: XML comment has syntactically incorrect cref attribute 'true'VSBuild |   |  
-- | -- | --
  | src\Appium.Net\Appium\Interfaces\IHidesKeyboard.cs(42,33): Warning CS1658: Identifier expected; 'true' is a keyword. See also error CS1041.VSBuild |   |  
  | src\Appium.Net\Appium\Interfaces\IHidesKeyboard.cs(42,74): Warning CS1584: XML comment has syntactically incorrect cref attribute 'false'VSBuild |   |  
  | src\Appium.Net\Appium\Interfaces\IHidesKeyboard.cs(42,74): Warning CS1658: Identifier expected; 'false' is a keyword. See also error CS1041.VSBuild |   |  
  | src\Appium.Net\Appium\MobileBy.cs(69,24): Warning CS1584: XML comment has syntactically incorrect cref attribute 'https://developer.android.com/intl/ru/training/accessibility/accessible-app.html'VSBuild |   |  
  | src\Appium.Net\Appium\MobileBy.cs(71,24): Warning CS1584: XML comment has syntactically incorrect cref attribute 'https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIAccessibilityIdentification_Protocol/index.html'VSBuild |   |  
  | src\Appium.Net\Appium\MobileBy.cs(80,24): Warning CS1584: XML comment has syntactically incorrect cref attribute 'http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis'VSBuild |   |  
  | src\Appium.Net\Appium\AppiumCommand.cs(277,1): Warning CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'summary'.'VSBuild |   |  
  | src\Appium.Net\Appium\MobileBy.cs(80,101): Warning CS1658: Unexpected character '#'. See also error CS1056.VSBuild |   |  
  | src\Appium.Net\Appium\MobileBy.cs(89,24): Warning CS1584: XML comment has syntactically incorrect cref attribute 'http://developer.android.com/intl/ru/tools/testing-support-library/index.html#uia-apis'VSBuild


Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions