From 4f6ac0b1d793ff6e7206b3c038f2863b48f7886f Mon Sep 17 00:00:00 2001 From: Petr Onderka Date: Sat, 8 Apr 2017 23:52:43 +0200 Subject: [PATCH] Formatting of XML comments --- .../Core/Portable/Symbols/ISymbol.cs | 62 ++++++++++++------- 1 file changed, 40 insertions(+), 22 deletions(-) diff --git a/src/Compilers/Core/Portable/Symbols/ISymbol.cs b/src/Compilers/Core/Portable/Symbols/ISymbol.cs index a5cbaf266fb64..dbdf1f831b57e 100644 --- a/src/Compilers/Core/Portable/Symbols/ISymbol.cs +++ b/src/Compilers/Core/Portable/Symbols/ISymbol.cs @@ -38,12 +38,14 @@ public interface ISymbol : IEquatable /// /// Gets the name of a symbol as it appears in metadata. Most of the time, this /// is the same as the Name property, with the following exceptions: - /// 1) The metadata name of generic types includes the "`1", "`2" etc. suffix that + /// + /// The metadata name of generic types includes the "`1", "`2" etc. suffix that /// indicates the number of type parameters (it does not include, however, names of - /// containing types or namespaces). - /// 2) The metadata name of explicit interface names have spaces removed, compared to - /// the name property. - /// 3) The length of names is limited to not exceed metadata restrictions. + /// containing types or namespaces). + /// The metadata name of explicit interface names have spaces removed, compared to + /// the name property. + /// The length of names is limited to not exceed metadata restrictions. + /// /// string MetadataName { get; } @@ -121,14 +123,18 @@ public interface ISymbol : IEquatable /// used by code, but that are simply declared implicitly rather than with explicit language /// syntax. /// + /// /// Examples include (this list is not exhaustive): - /// the default constructor for a class or struct that is created if one is not provided, - /// the BeginInvoke/Invoke/EndInvoke methods for a delegate, - /// the generated backing field for an auto property or a field-like event, - /// the "this" parameter for non-static methods, - /// the "value" parameter for a property setter, - /// the parameters on indexer accessor methods (not on the indexer itself), - /// methods in anonymous types + /// + /// the default constructor for a class or struct that is created if one is not provided, + /// the BeginInvoke/Invoke/EndInvoke methods for a delegate, + /// the generated backing field for an auto property or a field-like event, + /// the "this" parameter for non-static methods, + /// the "value" parameter for a property setter, + /// the parameters on indexer accessor methods (not on the indexer itself), + /// methods in anonymous types + /// + /// /// bool IsImplicitlyDeclared { get; } @@ -150,10 +156,12 @@ public interface ISymbol : IEquatable /// one or more syntax nodes only if the symbol was declared in source code and also was /// not implicitly declared (see the IsImplicitlyDeclared property). /// + /// /// Note that for namespace symbol, the declaring syntax might be declaring a nested namespace. /// For example, the declaring syntax node for N1 in "namespace N1.N2 {...}" is the entire /// NamespaceDeclarationSyntax for N1.N2. For the global namespace, the declaring syntax will /// be the CompilationUnitSyntax. + /// /// /// /// The syntax node(s) that declared the symbol. If the symbol was declared in metadata @@ -247,21 +255,31 @@ ImmutableArray ToMinimalDisplayParts( /// /// Indicates that this symbol uses metadata that cannot be supported by the language. /// + /// /// Examples include: - /// - Pointer types in VB - /// - ByRef return type - /// - Required custom modifiers - /// + /// + /// Pointer types in VB + /// ByRef return type + /// Required custom modifiers + /// + /// + /// + /// /// This is distinguished from, for example, references to metadata symbols defined in assemblies that weren't referenced. /// Symbols where this returns true can never be used successfully, and thus should never appear in any IDE feature. + /// /// + /// /// This is set for metadata symbols, as follows: - /// Type - if a type is unsupported (e.g., a pointer type, etc.) - /// Method - parameter or return type is unsupported - /// Field - type is unsupported - /// Event - type is unsupported - /// Property - type is unsupported - /// Parameter - type is unsupported + /// + /// Type - if a type is unsupported (e.g., a pointer type, etc.) + /// Method - parameter or return type is unsupported + /// Field - type is unsupported + /// Event - type is unsupported + /// Property - type is unsupported + /// Parameter - type is unsupported + /// + /// /// bool HasUnsupportedMetadata { get; } }