RefDocGen
Home
API
FAQ
Templates
Configuration
Basic config
Custom static pages
Doc versioning
YAML config
C#
public interface
IFieldData
assembly
RefDocGen
namespace
RefDocGen.CodeElements.Members.Abstract
Implements:
IValueMemberData
,
IMemberData
Represents data of a field.
Properties
public
AccessModifier
AccessModifier
{
get
;
}
#
Inherited from
IMemberData
Access modifier of the member.
public
IReadOnlyList
<
IAttributeData
>
Attributes
{
get
;
}
#
Inherited from
IMemberData
Collection of attributes applied to the member.
public
object
ConstantValue
{
get
;
}
#
Inherited from
IValueMemberData
Constant value of the member.
Returns
DBNull.Value
if the member has no constant value. (note that this is done, because
null
can be declared as a constant value of the member.
public
ITypeDeclaration
ContainingType
{
get
;
}
#
Inherited from
IMemberData
Type that contains the member.
Note that for inherited members, this property returns child type (not the original type that declares the member).
public
XElement
ExampleDocComment
{
get
;
}
#
Inherited from
IMemberData
'example' doc comment provided for the member.
public
FieldInfo
FieldInfo
{
get
;
}
#
FieldInfo
object representing the field.
public
string
Id
{
get
;
}
#
Inherited from
IMemberData
Identifier of the member in the same format as in the XML documentation comments file. Consists of the member name (without namespace and type name) and parameters string (if the member has them - e.g. a method).
Uniquely identifies the member within a type.
Remarks
The format is described here:
https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/#id-strings
public
ITypeNameData
InheritedFrom
{
get
;
}
#
Inherited from
IMemberData
If the member is inherited, this represents the type from which it originates.
null
if the member is not inherited.
public
bool
IsConstant
{
get
;
}
#
Inherited from
IValueMemberData
Checks if the member is a compile-time constant.
public
bool
IsInherited
{
get
;
}
#
Inherited from
IMemberData
Indicates whether the member is inhertied from another type.
public
bool
IsReadonly
{
get
;
}
#
Inherited from
IValueMemberData
Checks if the member is readonly (i.e. can be set just inside a constructor)
public
bool
IsRequired
{
get
;
}
#
Inherited from
IValueMemberData
Checks if the member is required (i.e. must be initialized by an object initializer).
Remarks
For further info, see
https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/required
.
public
bool
IsStatic
{
get
;
}
#
Inherited from
IMemberData
Checks whether the member is static.
public
MemberInfo
MemberInfo
{
get
;
}
#
Inherited from
IMemberData
MemberInfo
object representing the member.
public
string
Name
{
get
;
}
#
Inherited from
IMemberData
Name of the member.
public
XElement
RemarksDocComment
{
get
;
}
#
Inherited from
IMemberData
'remarks' doc comment for the member.
public
IEnumerable
<
XElement
>
SeeAlsoDocComments
{
get
;
}
#
Inherited from
IMemberData
Collection of 'seealso' doc comments for the member.
public
XElement
SummaryDocComment
{
get
;
}
#
Inherited from
IMemberData
'summary' doc comment for the member.
public
ITypeNameData
Type
{
get
;
}
#
Inherited from
IValueMemberData
Type of the member.
Made with
RefDocGen