Skip to content

Commit 14d9d65

Browse files
committed
Restrict feature set of AddReferencedNameAffix even more for simplicity
1 parent 6983172 commit 14d9d65

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

sources/SilkTouch/SilkTouch/Naming/NameAffixer.cs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,13 @@ public static SyntaxList<AttributeListSyntax> AddNameAffix(
158158
/// <remarks>
159159
/// This allows compound names to be handled more cleanly.
160160
/// <para/>
161-
/// For simplicity, only names within the same scope depth are currently supported.
162-
/// This should cover most real world use cases since
163-
/// if something is nested and has the parent name as a prefix,
164-
/// then the prefix is likely unnecessary.
161+
/// For simplicity, only names within the same name container are currently supported.
162+
/// This lets us skip sorting across different containers.
163+
/// This should cover most real world use cases since if something is nested and
164+
/// has the parent name as a prefix, then the prefix is likely unnecessary.
165+
/// <para/>
166+
/// Similarly, only direct references are supported. Transitive references are not.
167+
/// This lets us naively sort all references to the end of the container without a topological sort.
165168
/// </remarks>
166169
/// <example>
167170
/// For example, <c>PerformanceCounterDescriptionARM</c> can be used as a referenced prefix for <c>PerformanceCounterDescriptionARMName</c>.

0 commit comments

Comments
 (0)