public interface IEnumTypeData

assembly RefDocGen
namespace RefDocGen.CodeElements.Types.Abstract.Enum
Implements:  ITypeDeclaration, ITypeNameBaseData
Represents data of an enum type.

Properties

public AccessModifier AccessModifier { get; } #
Inherited from ITypeDeclaration
Access modifier of the type.
public IEnumerable<IMemberData> AllMembers { get; } #
Inherited from ITypeDeclaration
Collection of all members declared in the type.
Remarks
Note that nested types aren't included, see ITypeDeclaration.NestedTypes
public string Assembly { get; } #
Inherited from ITypeDeclaration
Name of the assembly containing the type.
public IReadOnlyList<IAttributeData> Attributes { get; } #
Inherited from ITypeDeclaration
Collection of attributes applied to the type.
Remarks
Note that the compiler generated attributes are not included.
public ITypeNameData BaseType { get; } #
Inherited from ITypeDeclaration
Base type of the type. Returns null, if the type has no base type (i.e. it's an interface or object type).
public ITypeDeclaration DeclaringType { get; } #
Inherited from ITypeDeclaration
The type that contains the declaration of this type.
null if the type is not nested.
public XElement ExampleDocComment { get; } #
Inherited from ITypeDeclaration
'example' doc comment provided to the type.
public string FullName { get; } #
Inherited from ITypeNameBaseData
Full name of the type, including its namespace.
Note: For generic types, it's doesn't include any info about the generic types.
Examples:
  • for string, it returns "System.String"
  • for List<string>, it returns "System.Collections.Generic.List"
public bool HasTypeParameters { get; } #
Inherited from ITypeNameBaseData
Checks whether the type has any type parameters.
public string Id { get; } #
Inherited from ITypeNameBaseData
Identifier of the type. Consists of the type name and generic parameters (if present).
The format is described here: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments#d42-id-string-format
public IReadOnlyList<ITypeNameData> Interfaces { get; } #
Inherited from ITypeDeclaration
Interfaces implemented by the current type.
public bool IsInterface { get; } #
Inherited from ITypeDeclaration
Indicates whether the type is an interface or not.
public bool IsNested { get; } #
Inherited from ITypeDeclaration
Indicates whether the type is a nested type.
public IEnumerable<IEnumMemberData> Members { get; } #
Collection of declared enum members.
public string Namespace { get; } #
Inherited from ITypeNameBaseData
Gets the namespace of the type.
Returns empty string, if the current instance represents a generic type parameter or if the type doesn't have any corresponding namespace.
public IEnumerable<ITypeDeclaration> NestedTypes { get; } #
Inherited from ITypeDeclaration
Collection of all nested types declared in the type.
public XElement RemarksDocComment { get; } #
Inherited from ITypeDeclaration
'remarks' doc comment provided to the type.
public IEnumerable<XElement> SeeAlsoDocComments { get; } #
Inherited from ITypeDeclaration
Collection of 'seealso' doc comments for the member.
public string ShortName { get; } #
Inherited from ITypeNameBaseData
Short name of the type; doesn't include its namespace.
Note: For generic types, it's doesn't include any info about the generic types.
Examples:
  • for string, it returns "String"
  • for List<string>, it returns "List"
public XElement SummaryDocComment { get; } #
Inherited from ITypeDeclaration
'summary' documentation comment provided to the type.
public Type TypeObject { get; } #
Inherited from ITypeNameBaseData
Type object representing the type.
public IReadOnlyList<ITypeParameterData> TypeParameters { get; } #
Inherited from ITypeDeclaration
Collection of generic type parameters declared in the type, ordered by their index.