CodeAnalysisKeys Class

Summary

Common metadata keys for code analysis modules.
Assembly
Wyam.CodeAnalysis.dll
Namespace
Wyam.CodeAnalysis
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["CodeAnalysisKeys"] class Type type-node

Syntax

public static class CodeAnalysisKeys

Fields

Name Constant Value Summary
Accessibility Accessibility
This is available for type, method, field, event, and property symbols and contains the declared accessibility of the symbol.
static
AllInterfaces AllInterfaces
This is available for type symbols and contains a collection of the documents that represent all implemented interfaces. The collection is empty if the type doesn't implement any interfaces.
static
AssemblyName AssemblyName
The name of the assembly for each input document. Used to group input documents by assembly (if provided). If this is not provided for each input source document, then analysis that depends on both source files and assemblies may not correctly bind symbols across multiple inputs.
static
AttributeData AttributeData
This is available for attribute symbols and contains the Roslyn Microsoft.CodeAnalysis.AttributeData instance for the attribute.
static
Attributes Attributes
This is available for type, method, field, event, property, parameter, and type parameter symbols and contains the type symbol documents for attributes applied to the symbol.
static
BaseTypes BaseTypes
This is available for type symbols and contains a collection of the documents that represent all base types (inner-most first).
static
CommentId CommentId
A unique ID that identifies the symbol for documentation purposes.
static
CommentXml CommentXml
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains the full unprocessed XML documentation comments content for this symbol. In addition, special metadata keys may be added for custom comment elements with the name [ElementName]Comments. These special metadata keys contain a Wyam.CodeAnalysis.OtherComment instance with the rendered HTML content (and any attributes) of the custom XML documentation comments with the given [ElementName].
static
ConstantValue ConstantValue
This is available for field symbols and contains the constant value (if one exists).
static
Constructors Constructors
This is available for type symbols and contains a collection of the documents that represent all constructors of the type. The collection is empty if the type doesn't have any explicit constructors.
static
ContainingAssembly ContainingAssembly
The document that represents the containing assembly (or null if this symbol is not from an assembly).
static
ContainingNamespace ContainingNamespace
The document that represents the containing namespace (or null if this symbol is not nested).
static
ContainingType ContainingType
This is available for type, method, field, event, property, and parameter symbols and contains a document representing the containing type(ornull if no containing type).
static
DeclaringType DeclaringType
This is available for type parameter symbols and contains a document that represents the declaring type of the type parameter.
static
DerivedTypes DerivedTypes
This is available for type symbols and contains a collection of the documents that represent all types derived from the type. The collection is empty if the type doesn't have any derived types.
static
DisplayName DisplayName
A display name for the symbol. For namespaces, this is the same as Wyam.CodeAnalysis.CodeAnalysisKeys.QualifiedName. For types, this is the same as Wyam.CodeAnalysis.CodeAnalysisKeys.FullName.
static
Example Example
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains the rendered HTML content from allexample XML documentation comments for this symbol.
static
Exceptions Exceptions
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains a collection of allexception XML documentation comments for this symbol with their name, link, and/or rendered HTML content.
static
ExtensionMethods ExtensionMethods
This is available for type symbols and contains a collection of the documents that represent all extension members applicable to the type.
static
FullName FullName
The full name of the symbol. For namespaces, this is the name of the namespace. For types, this includes all generic type parameters.
static
HasConstantValue HasConstantValue
This is available for field symbols and indicates whether a constant value is available for the field.
static
ImplementingTypes ImplementingTypes
This is available for interface symbols and contains a collection of the documents that represent all types that implement the interface. The collection is empty if no other types implement the interface.
static
IsAbstract IsAbstract
Indicates if the symbol is abstract.
static
IsOverride IsOverride
Indicates if the symbol is an override.
static
IsResult IsResult
By default only certain symbols are processed as part of the initial result set(such as those that match the specified predicate). If this value is true, then this symbol was part of the initial result set. If it is false, the symbol was lazily processed later while fetching related symbols and may not contain the full set of metadata.
static
IsStatic IsStatic
Indicates if the symbol is static.
static
IsVirtual IsVirtual
Indicates if the symbol is virtual.
static
Kind Kind
This is the general kind of symbol. For example, the for a namespace this is "Namespace" and for a type this is "NamedType".
static
MemberNamespaces MemberNamespaces
This is available for namespace symbols and contains a collection of the documents that represent all member namespaces. The collection is empty if there are no member namespaces.
static
Members Members
This is available for type symbols and contains a collection of the documents that represent all members of the type, including inherited ones. The collection is empty if the type doesn't have any members.
static
MemberTypes MemberTypes
This is available for namespace and type symbols and contains a collection of the documents that represent all member types. It only contains direct children (as opposed to all nested types).
static
Name Name
The name of the symbol, or an empty string if the symbol has no name (like the global namespace).
static
Operators Operators
This is available for type symbols and contains a collection of the documents that represent all operators of the type, including inherited ones. The collection is empty if the type doesn't have any operators.
static
OriginalDefinition OriginalDefinition
If this symbol is derived from another symbol, by type substitution for instance, this gets a document representing the original definition. If this symbol is not derived from another symbol, this gets a document representing the current definition.
static
OutputBuildLog OutputBuildLog
Set this to true in the global settings to generate a binary build log when analyzing projects or solutions. The log will be output alongside the project file.
static
OverriddenMethod OverriddenMethod
This is available for method symbols and contains a document that represents the method being overridden (or null if no method is overriden by this one).
static
Parameters Parameters
This is available for method and property (I.e., indexer) symbols and contains a collection of the documents that represent the parameters of the method or property.
static
Params Params
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains a collection of allparam XML documentation comments for this symbol with their name, link, and/or rendered HTML content.
static
Permissions Permissions
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains a collection of allpermission XML documentation comments for this symbol with their name, link, and/or rendered HTML content.
static
QualifiedName QualifiedName
The qualified name of the symbol which includes all containing namespaces.
static
Remarks Remarks
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains the rendered HTML content from allremarks XML documentation comments for this symbol.
static
Returns Returns
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains the rendered HTML content from allreturns XML documentation comments for this symbol.
static
ReturnType ReturnType
This is available for method symbols and contains a document that represents the return type of the method (or null if the method returns void).
static
SeeAlso SeeAlso
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains a collection of allseealso XML documentation comments for this symbol with their rendered HTML link (or just name if no link could be generated).
static
SpecificKind SpecificKind
The more specific kind of the symbol ("Class", "Struct", etc.) This is the same as Kind if there is no more specific kind.
static
Summary Summary
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains the rendered HTML content from allsummary XML documentation comments for this symbol.
static
Symbol Symbol
The Roslyn ISymbol from which this document is derived. If the document represents a namespace, this metadata might contain more than one symbol since the namespaces documents consolidate same-named namespaces across input code and assemblies.
static
SymbolId SymbolId
A unique ID that identifies the symbol (can be used for generating folder paths, for example).
static
Syntax Syntax
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains a generated syntax example for the symbol.
static
Type Type
This is available for field, event, property, and parameter symbols and contains the document that represents the type of the symbol.
static
TypeArguments TypeArguments
This is available for type and method symbols and contains a collection of the documents that represent all generic type arguments of the type or method. The collection is empty if the type or method doesn't have any generic type parameters.
static
TypeParameters TypeParameters
This is available for type and method symbols and contains a collection of the documents that represent all generic type parameters of the type or method. The collection is empty if the type or method doesn't have any generic type parameters.
static
TypeParams TypeParams
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains a collection of alltypeparam XML documentation comments for this symbol with their name, link, and/or rendered HTML content.
static
Value Value
This is available for documents in the initial result set (Wyam.CodeAnalysis.CodeAnalysisKeys.IsResult is true) and contains the rendered HTML content from allvalue XML documentation comments for this symbol.
static
GitHub