RefDocGen
Home
API
FAQ
Templates
Configuration
Basic config
Custom static pages
Doc versioning
YAML config
C#
public interface
IMemberData
assembly
RefDocGen
namespace
RefDocGen.CodeElements.Members.Abstract
Represents data of a type member (such as a field, property or a method).
Properties
public
AccessModifier
AccessModifier
{
get
;
}
#
Access modifier of the member.
public
IReadOnlyList
<
IAttributeData
>
Attributes
{
get
;
}
#
Collection of attributes applied to the member.
public
ITypeDeclaration
ContainingType
{
get
;
}
#
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
;
}
#
'example' doc comment provided for the member.
public
string
Id
{
get
;
}
#
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
;
}
#
If the member is inherited, this represents the type from which it originates.
null
if the member is not inherited.
public
bool
IsInherited
{
get
;
}
#
Indicates whether the member is inhertied from another type.
public
bool
IsStatic
{
get
;
}
#
Checks whether the member is static.
public
MemberInfo
MemberInfo
{
get
;
}
#
MemberInfo
object representing the member.
public
string
Name
{
get
;
}
#
Name of the member.
public
XElement
RemarksDocComment
{
get
;
}
#
'remarks' doc comment for the member.
public
IEnumerable
<
XElement
>
SeeAlsoDocComments
{
get
;
}
#
Collection of 'seealso' doc comments for the member.
public
XElement
SummaryDocComment
{
get
;
}
#
'summary' doc comment for the member.
Made with
RefDocGen