Skip to content

issues Search Results · repo:DotNetAnalyzers/DocumentationAnalyzers language:C#

Filter by

51 results
 (59 ms)

51 results

inDotNetAnalyzers/DocumentationAnalyzers (press backspace or delete to remove)

I was looking for a tool that forces workspace members to write XML documentation and write it correctly. actually, that s how I found this repository. I was wondering if we could add this feature and ...
  • sorousherafat
  • 2
  • Opened 
    on Jun 29, 2022
  • #92

see langword= dynamic / causes a DOC207 violation. I d expect it not to since dynamic is a C# keyword.
  • Piedone
  • Opened 
    on Jul 20, 2021
  • #90

Simple fix to the descriptions of these; missing the word documentation and contains in a few spots.
  • doctorlard
  • 1
  • Opened 
    on Feb 11, 2021
  • #86

The documentation for StyleCopy analyzers shows how to fix the violation and how to suppress it, but it would be really, really helpful to also put in the documentation the setting for it in the .editorconfig ...
  • RealDotNetDave
  • 1
  • Opened 
    on Nov 5, 2020
  • #85

The link to Configuration.md in the readme is broken.
help wanted
  • RealDotNetDave
  • 3
  • Opened 
    on Nov 5, 2020
  • #84

Example of this error: https://github.com/dotnet/roslyn/blob/00247a7273f1ea229d5accce18352d65f8aa6d72/src/Workspaces/SharedUtilitiesAndExtensions/Compiler/Core/Utilities/ReferenceCountedDisposable.cs#L42-L50 ...
analyzer
  • sharwell
  • Opened 
    on Apr 8, 2020
  • #82

public class C { /// param name= fileName 1 /param public void M(string fileName) { } /// param name= fileName 2 /param public void M(string fileName, bool b) { } } Often we want ...
  • JohanLarsson
  • 1
  • Opened 
    on Feb 17, 2019
  • #79

For example: /// summary A valid summary /summary /// Some invalid text public void Foo() {} /// summary A valid summary /summary /// Some invalid text /// remarks A valid remark /remarks public ...
analyzer
  • drewnoakes
  • Opened 
    on Dec 20, 2018
  • #78

/// see cref= Foo / public bool Bar(); This is invalid. The author probably intended: /// seealso cref= Foo / public bool Bar();
enhancement
help wanted
  • drewnoakes
  • 3
  • Opened 
    on Nov 20, 2018
  • #75

I don t think there s a valid reason to have a returns element on a void typed member: /// returns Nothing at all! /returns public void Foo(); Nor on a type: /// returns Nothing at all! /returns ...
analyzer
help wanted
  • drewnoakes
  • 2
  • Opened 
    on Nov 19, 2018
  • #74
Issue origami icon

Learn how you can use GitHub Issues to plan and track your work.

Save views for sprints, backlogs, teams, or releases. Rank, sort, and filter issues to suit the occasion. The possibilities are endless.Learn more about GitHub Issues
ProTip! 
Press the
/
key to activate the search input again and adjust your query.
Issue origami icon

Learn how you can use GitHub Issues to plan and track your work.

Save views for sprints, backlogs, teams, or releases. Rank, sort, and filter issues to suit the occasion. The possibilities are endless.Learn more about GitHub Issues
ProTip! 
Restrict your search to the title by using the in:title qualifier.
Issue search results · GitHub