Skip to content

Commit

Permalink
Remove pointless xml doc comment tags (#76696)
Browse files Browse the repository at this point in the history
  • Loading branch information
CyrusNajmabadi authored Jan 9, 2025
2 parents ee47532 + cdcfce1 commit 43e859b
Show file tree
Hide file tree
Showing 57 changed files with 0 additions and 70 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ internal sealed class CSharpUseSystemThreadingLockDiagnosticAnalyzer()
/// <summary>
/// A method body edit anywhere in a type will force us to reanalyze the whole type.
/// </summary>
/// <returns></returns>
public override DiagnosticAnalyzerCategory GetAnalyzerCategory()
=> DiagnosticAnalyzerCategory.SemanticDocumentAnalysis;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,6 @@ private static bool IsSafeAssignment(IOperation operation)
/// </summary>
/// <param name="operation"></param>
/// <param name="methodSymbol">the symbol of the equals method</param>
/// <returns></returns>
private static ImmutableArray<IFieldSymbol> GetEqualizedFields(
IMethodBodyOperation operation,
IMethodSymbol methodSymbol)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,6 @@ protected virtual bool ShouldBailOutFromRemovableAssignmentAnalysis(IOperation u
/// Indicates if the given expression statement operation has an explicit "Call" statement syntax indicating explicit discard.
/// For example, VB "Call" statement.
/// </summary>
/// <returns></returns>
protected abstract bool IsCallStatement(IExpressionStatementOperation expressionStatement);

/// <summary>
Expand All @@ -147,7 +146,6 @@ protected virtual bool ShouldBailOutFromRemovableAssignmentAnalysis(IOperation u
/// and hence can be removed completely. For example, if the assigned value is a constant or a reference
/// to a local/parameter, then it has no side effects, but if it is method invocation, it may have side effects.
/// </summary>
/// <returns></returns>
private static PropertiesMap CreatePropertiesMap()
{
var builder = ImmutableDictionary.CreateBuilder<(UnusedValuePreference preference, bool isUnusedLocalAssignment, bool isRemovableAssignment),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ private static void ClearAndFree(ConcurrentDictionary<IFieldSymbol, ConcurrentSe
/// <summary>
/// A method body edit anywhere in a type will force us to reanalyze the whole type.
/// </summary>
/// <returns></returns>
public override DiagnosticAnalyzerCategory GetAnalyzerCategory()
=> DiagnosticAnalyzerCategory.SemanticDocumentAnalysis;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ public static bool HasCascadingDeclarations(IMethodSymbol method)
/// Adds a parameter to a method.
/// </summary>
/// <param name="newParameterIndex"><see langword="null"/> to add as the final parameter</param>
/// <returns></returns>
public static async Task<Solution> AddParameterAsync<TExpressionSyntax>(
Document invocationDocument,
IMethodSymbol method,
Expand Down
1 change: 0 additions & 1 deletion src/Dependencies/PooledObjects/PooledStringBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ public string ToStringAndFree(int startIndex, int length)
/// If someone need to create a private pool
/// </summary>
/// <param name="size">The size of the pool.</param>
/// <returns></returns>
public static ObjectPool<PooledStringBuilder> CreatePool(int size = 32)
{
ObjectPool<PooledStringBuilder>? pool = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,6 @@ internal interface IEditorInlineRenameService : ILanguageService
/// <param name="inlineRenameInfo"></param>
/// <param name="inlineRenameLocationSet"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
Task<ImmutableDictionary<string, ImmutableArray<(string filePath, string content)>>> GetRenameContextAsync(
IInlineRenameInfo inlineRenameInfo,
IInlineRenameLocationSet inlineRenameLocationSet,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ internal static class ITextBufferEditExtensions
/// Logs exceptions thrown during <see cref="ITextBufferEdit.Apply"/> as we look for issues.
/// </summary>
/// <param name="edit"></param>
/// <returns></returns>
public static ITextSnapshot ApplyAndLogExceptions(this ITextBufferEdit edit)
{
try
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ internal static class SpanExtensions
/// Convert the editor Span instance to the corresponding TextSpan instance
/// </summary>
/// <param name="span"></param>
/// <returns></returns>
public static TextSpan ToTextSpan(this Span span)
=> new(span.Start, span.Length);

Expand Down
1 change: 0 additions & 1 deletion src/EditorFeatures/Test2/Peek/PeekTests.vb
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,6 @@ public partial class D
''' Returns the text of the identifier line, starting at the identifier and ending at end of the line.
''' </summary>
''' <param name="index"></param>
''' <returns></returns>
Friend Function GetRemainingIdentifierLineTextOnDisk(index As Integer) As String
Dim documentResult = DirectCast(Items(index), IDocumentPeekResult)
Dim textBufferService = _workspace.GetService(Of ITextBufferFactoryService)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,6 @@ public void OpenSourceGeneratedDocument(DocumentId documentId)
/// preserved. The markup may also contain the caret indicator.</param>
/// <param name="baseDocuments">The set of documents from which the projection buffer
/// document will be composed.</param>
/// <returns></returns>
public EditorTestHostDocument CreateProjectionBufferDocument(
string markup,
IList<EditorTestHostDocument> baseDocuments,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,6 @@ private bool TryConvertInternal(QueryExpressionProcessingInfo queryExpressionPro
/// Checks if the location of the query expression allows to convert it at least to a local function.
/// It still does not guarantees that the conversion can be performed. There can be bail outs of later stages.
/// </summary>
/// <returns></returns>
private bool CanTryConvertToLocalFunction()
{
SyntaxNode currentNode = _source;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ internal abstract class AbstractConverter(ForEachInfo<ForEachStatementSyntax, St
/// <param name="leadingTokensForSelect">extra leading tokens to be added to the select clause</param>
/// <param name="trailingTokensForSelect">extra trailing tokens to be added to the select clause</param>
/// <param name="convertToQuery">Flag indicating if a query expression should be generated</param>
/// <returns></returns>
protected ExpressionSyntax CreateQueryExpressionOrLinqInvocation(
ExpressionSyntax selectExpression,
IEnumerable<SyntaxToken> leadingTokensForSelect,
Expand All @@ -52,7 +51,6 @@ protected ExpressionSyntax CreateQueryExpressionOrLinqInvocation(
/// <param name="selectExpression">expression to be used into the last 'select ...' in the query expression</param>
/// <param name="leadingTokensForSelect">extra leading tokens to be added to the select clause</param>
/// <param name="trailingTokensForSelect">extra trailing tokens to be added to the select clause</param>
/// <returns></returns>
private QueryExpressionSyntax CreateQueryExpression(
ExpressionSyntax selectExpression,
IEnumerable<SyntaxToken> leadingTokensForSelect,
Expand Down Expand Up @@ -121,7 +119,6 @@ private static FromClauseSyntax CreateFromClause(
/// <param name="selectExpression">expression to be used in the last 'Select' invocation</param>
/// <param name="leadingTokensForSelect">extra leading tokens to be added to the select clause</param>
/// <param name="trailingTokensForSelect">extra trailing tokens to be added to the select clause</param>
/// <returns></returns>
private ExpressionSyntax CreateLinqInvocationOrSimpleExpression(
ExpressionSyntax selectExpression,
IEnumerable<SyntaxToken> leadingTokensForSelect,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,11 @@ internal sealed partial class CSharpCopilotCodeFixProvider() : CodeFixProvider
/// <summary>
/// Ensure that fixes for Copilot diagnostics are always towards the bottom of the lightbulb.
/// </summary>
/// <returns></returns>
protected sealed override CodeActionRequestPriority ComputeRequestPriority() => CodeActionRequestPriority.Low;

/// <summary>
/// We do not support a FixAll operation for Copilot suggestions.
/// </summary>
/// <returns></returns>
public sealed override FixAllProvider? GetFixAllProvider() => null;

public sealed override ImmutableArray<string> FixableDiagnosticIds => [CopilotDiagnosticId];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ internal interface IChangeSignatureOptionsService : IWorkspaceService
/// parameters)</param>
/// <param name="symbol">the symbol for changing the signature</param>
/// <param name="parameters">existing parameters of the symbol</param>
/// <returns></returns>
ChangeSignatureOptionsResult? GetChangeSignatureOptions(
SemanticDocument document,
int positionForTypeBinding,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ private CharacterSetModificationRule(CharacterSetModificationKind kind, Immutabl
/// </summary>
/// <param name="kind">The kind of rule.</param>
/// <param name="characters">One or more characters. These are typically punctuation characters.</param>
/// <returns></returns>
public static CharacterSetModificationRule Create(CharacterSetModificationKind kind, ImmutableArray<char> characters)
=> new(kind, characters);

Expand All @@ -41,7 +40,6 @@ public static CharacterSetModificationRule Create(CharacterSetModificationKind k
/// </summary>
/// <param name="kind">The kind of rule.</param>
/// <param name="characters">One or more characters. These are typically punctuation characters.</param>
/// <returns></returns>
public static CharacterSetModificationRule Create(CharacterSetModificationKind kind, params char[] characters)
=> new(kind, [.. characters]);
}
1 change: 0 additions & 1 deletion src/Features/Core/Portable/Completion/CompletionItem.cs
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,6 @@ internal static CompletionItem CreateInternal(
/// <param name="properties">Additional information.</param>
/// <param name="tags">Descriptive tags that may influence how the item is displayed.</param>
/// <param name="rules">The rules that declare how this item should behave.</param>
/// <returns></returns>
[Obsolete("Use the Create overload that does not take a span", error: true)]
[EditorBrowsable(EditorBrowsableState.Never)]
public static CompletionItem Create(
Expand Down
3 changes: 0 additions & 3 deletions src/Features/Core/Portable/Completion/CompletionItemRules.cs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ private CompletionItemRules(
/// <param name="enterKeyRule">Rule about whether the enter key is passed through to the editor after the selected item has been committed.</param>
/// <param name="formatOnCommit">True if the modified text should be formatted automatically.</param>
/// <param name="matchPriority">True if the related completion item should be initially selected.</param>
/// <returns></returns>
public static CompletionItemRules Create(
ImmutableArray<CharacterSetModificationRule> filterCharacterRules,
ImmutableArray<CharacterSetModificationRule> commitCharacterRules,
Expand All @@ -123,7 +122,6 @@ public static CompletionItemRules Create(
/// <param name="formatOnCommit">True if the modified text should be formatted automatically.</param>
/// <param name="matchPriority">True if the related completion item should be initially selected.</param>
/// <param name="selectionBehavior">How this item should be selected if no text has been typed after the completion list is brought up.</param>
/// <returns></returns>
public static CompletionItemRules Create(
ImmutableArray<CharacterSetModificationRule> filterCharacterRules = default,
ImmutableArray<CharacterSetModificationRule> commitCharacterRules = default,
Expand Down Expand Up @@ -157,7 +155,6 @@ public static CompletionItemRules Create(
/// <param name="enterKeyRule">Rule about whether the enter key is passed through to the editor after the selected item has been committed.</param>
/// <param name="formatOnCommit">True if the modified text should be formatted automatically.</param>
/// <param name="preselect">True if the related completion item should be initially selected.</param>
/// <returns></returns>
internal static CompletionItemRules Create(
ImmutableArray<CharacterSetModificationRule> filterCharacterRules,
ImmutableArray<CharacterSetModificationRule> commitCharacterRules,
Expand Down
1 change: 0 additions & 1 deletion src/Features/Core/Portable/Completion/CompletionList.cs
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,6 @@ private CompletionList(
/// <param name="items">The completion items to present to the user.</param>
/// <param name="rules">The rules used to control behavior of the completion list shown to the user during typing.</param>
/// <param name="suggestionModeItem">An optional <see cref="CompletionItem"/> that appears selected in the list presented to the user during suggestion mode.</param>
/// <returns></returns>
public static CompletionList Create(
TextSpan defaultSpan,
ImmutableArray<CompletionItem> items,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,5 @@ internal interface ICopilotOptionsService : ILanguageService
/// <summary>
/// Returns true if Copilot on-the-fly docs feature is enabled.
/// </summary>
/// <returns></returns>
Task<bool> IsOnTheFlyDocsOptionEnabledAsync();
}
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,6 @@ public Result<StackFrameToken> TryScanPath()
/// Returns a number token with the <see cref="StackFrameKind.LineTrivia"/> and remaining <see cref="StackFrameKind.SkippedTextTrivia"/>
/// attached to it.
/// </summary>
/// <returns></returns>
public StackFrameToken? TryScanRequiredLineNumber()
{
var lineTrivia = TryScanLineTrivia();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ protected virtual bool IsReadOutside(ISymbol symbol, HashSet<ISymbol> readOutsid
/// <summary>
/// check whether the selection is at the placed where read-only field is allowed to be extracted out
/// </summary>
/// <returns></returns>
protected abstract bool ReadOnlyFieldAllowed();

public AnalyzerResult Analyze()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ public TExecutableStatementSyntax GetLastStatement()
/// name="predicate"/>. Will not descend into local functions or lambdas.
/// </summary>
/// <param name="predicate"></param>
/// <returns></returns>
private bool CheckNodesInSelection(Func<ISyntaxFacts, SyntaxNode, bool> predicate)
{
var firstToken = this.GetFirstTokenInSelection();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ private static bool IsViableProperty(IPropertySymbol property)
/// </summary>
/// <param name="selectedMembers"></param>
/// <param name="rules"></param>
/// <returns></returns>
public static ImmutableArray<IParameterSymbol> DetermineParameters(
ImmutableArray<ISymbol> selectedMembers, ImmutableArray<NamingRule> rules)
{
Expand Down
1 change: 0 additions & 1 deletion src/Features/Core/Portable/QuickInfo/IndentationHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ internal static class IndentationHelper
/// <param name="text"></param>
/// <param name="classifiedSpans">The initial set of spans to align.</param>
/// <param name="tabSize">The number of spaces to </param>
/// <returns></returns>
public static ImmutableArray<ClassifiedSpan> GetSpansWithAlignedIndentation(
SourceText text,
ImmutableArray<ClassifiedSpan> classifiedSpans,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ internal interface IVisualDiagnosticsLanguageService : IWorkspaceService, IDispo
/// </summary>
/// <param name="serviceBroker">Service broker</param>
/// <param name="token">Cancellation token</param>
/// <returns></returns>
Task InitializeAsync(IServiceBroker serviceBroker, CancellationToken token);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ internal interface IBrokeredServiceBridgeManifest
/// Returns services that the container wishes to expose across the bridge.
/// </summary>
/// <param name="cancellationToken"></param>
/// <returns></returns>
ValueTask<IReadOnlyCollection<ServiceMoniker>> GetAvailableServicesAsync(CancellationToken cancellationToken);
}

Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,6 @@ public async Task<string> GetVsTestConsolePathAsync(string projectOutputDirector
/// Based on https://github.com/dotnet/msbuild/blob/main/src/Utilities/ToolTask.cs#L1259
/// We also do not include DOTNET_ROOT here, see https://github.com/dotnet/runtime/issues/88754
/// </summary>
/// <returns></returns>
internal string GetDotNetPathOrDefault()
{
var (fileName, sep) = PlatformInformation.IsWindows
Expand Down
1 change: 0 additions & 1 deletion src/LanguageServer/Protocol/Extensions/Extensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,6 @@ public static ContainerElement ToLSPElement(this QuickInfoContainerElement eleme
/// in the Visual Studio client.
/// </summary>
/// <param name="glyph"></param>
/// <returns></returns>
/// <exception cref="ArgumentException"></exception>
public static (Guid guid, int id) GetVsImageData(this Glyph glyph)
{
Expand Down
1 change: 0 additions & 1 deletion src/Scripting/Core/ScriptOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,6 @@ public ScriptOptions WithFileEncoding(Encoding encoding)
/// <summary>
/// Create a new <see cref="ScriptOptions"/> with the specified <see cref="OptimizationLevel"/>.
/// </summary>
/// <returns></returns>
public ScriptOptions WithOptimizationLevel(OptimizationLevel optimizationLevel)
=> optimizationLevel == OptimizationLevel ? this : new ScriptOptions(this) { OptimizationLevel = optimizationLevel };

Expand Down
1 change: 0 additions & 1 deletion src/Test/Perf/Utilities/PerfTestBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ public PerfTest([CallerFilePath] string workingFile = "") : base(workingFile) {
/// <summary>
/// A list of scenarios.
/// </summary>
/// <returns></returns>
public abstract string[] GetScenarios();

public virtual ITraceManager GetTraceManager()
Expand Down
1 change: 0 additions & 1 deletion src/Test/Perf/Utilities/RelativeDirectory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ public string TempDirectory
/// Returns the directory that contains built roslyn binaries. Usually this will be
/// Binaries/Debug or Binaries/Release.
/// </summary>
/// <returns></returns>
public string MyBinaries()
{
ThrowIfNotSetup();
Expand Down
1 change: 0 additions & 1 deletion src/Tools/BuildBoss/CompilerNuGetCheckerUtil.cs
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,6 @@ private static IEnumerable<PackagePart> GetPartsInFolder(Package package, string
/// properly update this package.
/// </summary>
/// <param name="textWriter"></param>
/// <returns></returns>
private bool CheckExternalApis(TextWriter textWriter)
{
var packageFilePath = FindNuGetPackage(Path.Combine(ArtifactsDirectory, "VSSetup", Configuration, "DevDivPackages"), "VS.ExternalAPIs.Roslyn");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,6 @@ public bool CodeMarkerEx(int nTimerID, string stringData)
/// Converts a string into a byte buffer including a zero terminator (needed for proper ETW message formatting)
/// </summary>
/// <param name="stringData">String to be converted to bytes</param>
/// <returns></returns>
internal static byte[] StringToBytesZeroTerminated(string stringData)
{
var encoding = System.Text.Encoding.Unicode;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1114,7 +1114,6 @@ internal void OpenDocumentFromPath(string? filePath, ProjectId projectId, bool a
/// <param name="filePath">the file path of the file to open.</param>
/// <param name="projectId">used to retrieve the IVsHierarchy to ensure the file is opened in a matching context.</param>
/// <param name="frame">the window frame.</param>
/// <returns></returns>
private bool TryGetFrame(string? filePath, ProjectId projectId, [NotNullWhen(returnValue: true)] out IVsWindowFrame? frame)
{
frame = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ public static IUIAutomationElement FindDescendantByClass(this IUIAutomationEleme
/// Given an <see cref="IUIAutomationElement"/>, returns all descendants with the given <paramref name="className"/>.
/// If none are found, the resulting collection will be empty.
/// </summary>
/// <returns></returns>
public static IUIAutomationElementArray FindDescendantsByClass(this IUIAutomationElement parent, string className)
{
if (parent == null)
Expand Down Expand Up @@ -310,7 +309,6 @@ private static void ThrowUnableToFindChildException(string path, IUIAutomationEl
/// support the <see cref="IUIAutomationTogglePattern"/>.
/// </summary>
/// <param name="element"></param>
/// <returns></returns>
public static bool IsToggledOn(this IUIAutomationElement element)
{
var togglePattern = element.GetCurrentPattern<IUIAutomationTogglePattern>(UIA_PatternIds.UIA_TogglePatternId);
Expand Down
Loading

0 comments on commit 43e859b

Please sign in to comment.