NameQualifier Enum
- Namespace
- Kampute.DocToolkit.Languages
- Assembly
- Kampute.DocToolkit.dll
Definition
Defines the level of qualification for name of a member.
public enum NameQualifierFields
| Name | Value | Description |
|---|---|---|
| None | 0 | No qualification is applied to the member's name. |
| DeclaringType | 1 | Qualifies the member's name with the type that declares it. |
| Full | 2 | Qualifies the member's name with the namespace that contains it and the type that declares it. |
The NameQualifier enum provides control over how member names are displayed in documentation. This affects code references, signatures, and links throughout the documentation system.
Different qualification levels are useful in different contexts:- None–Used when the member's context is already clear, such as in class documentation
- DeclaringType–Default for most cases, provides context without excessive verbosity
- Full–Used for API references or when members from different namespaces need to be distinguished
By controlling name qualification, documentation generators can balance between readability and precision in member references based on the context in which they appear.