DocumentationContextExtensions.DetermineNameQualifier Method

Namespace

Assembly

Kampute.DocToolkit.dll

Definition

Determines the most suitable name qualifier for displaying the specified member in the context of the current documentation scope.

public static NameQualifier DetermineNameQualifier(this IDocumentationContext context, IMember member)

Parameters

context IDocumentationContext: The documentation context to use for determining the preferred name qualifier.
member IMember: The member for which to determine the preferred name qualifier.

Returns

NameQualifier: The preferred NameQualifier for displaying the specified member.

Exceptions

ArgumentNullException: Thrown when context or member is null.

Remarks

This method helps in deciding how to qualify the name of a member when generating documentation based on the current scope of the documentation context.

Types always use NameQualifier.DeclaringType.
Extension methods and operators use NameQualifier.None.
Other members use NameQualifier.None if they belong to the type currently being documented; otherwise, they use NameQualifier.DeclaringType.