fixed operator documentation page overlapping names

Doraku · Mar 15, 2020 · 74286e2 · 74286e2
1 parent 600adf1
commit 74286e2
Show file tree

Hide file tree

Showing 59 changed files with 535 additions and 416 deletions.
diff --git a/source/DefaultDocumentation/DefaultDocumentation.Release.csproj b/source/DefaultDocumentation/DefaultDocumentation.Release.csproj
@@ -12,6 +12,8 @@
 breaking change:
 changed netcoreapp to v3.0
 do not generate base homepage if there is only one namespace present and no DefaultDocumentationHome specified nor any AssemblyDoc
+
+fixed operator documentation page overlapping names
     </PackageReleaseNotes>
   </PropertyGroup>
 </Project>
diff --git a/source/DefaultDocumentation/Model/DocItem.cs b/source/DefaultDocumentation/Model/DocItem.cs
@@ -56,9 +56,37 @@ protected DocItem(DocItem parent, string id, string fullName, string name, XElem
         }
 
         protected DocItem(DocItem parent, IEntity entity, XElement documentation)
-            : this(parent, entity.GetIdString(), FullNameAmbience.ConvertSymbol(entity), (entity is ITypeDefinition ? TypeNameAmbience : NameAmbience).ConvertSymbol(entity), documentation)
+            : this(parent, entity.GetIdString(), GetFullName(entity), (entity is ITypeDefinition ? TypeNameAmbience : NameAmbience).ConvertSymbol(entity), documentation)
         { }
 
+        private static string GetFullName(IEntity entity)
+        {
+            string fullName = FullNameAmbience.ConvertSymbol(entity);
+
+            if (entity.SymbolKind == SymbolKind.Operator)
+            {
+                int index = fullName.IndexOf(".operator ") + 1;
+                if (index <= 0)
+                {
+                    index = fullName.IndexOf(".implicit operator ") + 1;
+                    int offset = 17;
+                    if (index <= 0)
+                    {
+                        index = fullName.IndexOf(".explicit operator ") + 1;
+                        offset = 17;
+                    }
+
+                    fullName = fullName.Substring(0, index) + entity.Name + fullName.Substring(index + offset);
+                }
+                else
+                {
+                    fullName = fullName.Substring(0, index) + entity.Name + fullName.Substring(fullName.IndexOf('('));
+                }
+            }
+
+            return fullName;
+        }
+
         public abstract void WriteDocumentation(DocumentationWriter writer);
     }
 }
diff --git a/source/Dummy/documentation/Dummy-DummyClass--ctor().md b/source/Dummy/documentation/Dummy-DummyClass--ctor().md
diff --git a/...ummy/documentation/Dummy-DummyClass-Addition(Dummy-DummyClass-_System-Int32).md b/...ummy/documentation/Dummy-DummyClass-Addition(Dummy-DummyClass-_System-Int32).md
diff --git a/...ocumentation/Dummy-DummyClass-BitwiseAnd(Dummy-DummyClass-_Dummy-DummyClass).md b/...ocumentation/Dummy-DummyClass-BitwiseAnd(Dummy-DummyClass-_Dummy-DummyClass).md
diff --git a/...documentation/Dummy-DummyClass-BitwiseOr(Dummy-DummyClass-_Dummy-DummyClass).md b/...documentation/Dummy-DummyClass-BitwiseOr(Dummy-DummyClass-_Dummy-DummyClass).md
diff --git a/source/Dummy/documentation/Dummy-DummyClass-Decrement(Dummy-DummyClass).md b/source/Dummy/documentation/Dummy-DummyClass-Decrement(Dummy-DummyClass).md
diff --git a/.../documentation/Dummy-DummyClass-Division(Dummy-DummyClass-_Dummy-DummyClass).md b/.../documentation/Dummy-DummyClass-Division(Dummy-DummyClass-_Dummy-DummyClass).md
diff --git a/source/Dummy/documentation/Dummy-DummyClass-DummyClass().md b/source/Dummy/documentation/Dummy-DummyClass-DummyClass().md
@@ -0,0 +1,6 @@
+### [Dummy](./Dummy.md 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
+## DummyClass() Constructor
+dummy  
+```csharp
+public DummyClass();
+```
diff --git a/source/Dummy/documentation/Dummy-DummyClass-DummyField.md b/source/Dummy/documentation/Dummy-DummyClass-DummyField.md
@@ -1,4 +1,8 @@
-#### [Dummy](./Dummy.md 'Dummy')
-### [Dummy](./Dummy.md#Dummy 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
-## DummyField `field`
-dummy
+### [Dummy](./Dummy.md 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
+## DummyClass.DummyField Field
+dummy  
+```csharp
+public DummyField;
+```
+#### Field Value
+[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')  
diff --git a/source/Dummy/documentation/Dummy-DummyClass-DummyMethod-T2-(T2).md b/source/Dummy/documentation/Dummy-DummyClass-DummyMethod-T2-(T2).md
@@ -1,16 +1,16 @@
-#### [Dummy](./Dummy.md 'Dummy')
-### [Dummy](./Dummy.md#Dummy 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
-## DummyMethod&lt;T2&gt;(T2) `method`
-dummy
-### Type parameters
-
+### [Dummy](./Dummy.md 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
+## DummyClass.DummyMethod&lt;T2&gt;(T2) Method
+dummy  
+```csharp
+public void DummyMethod<T2>(T2 pouet);
+```
+#### Type parameters
 <a name='Dummy-DummyClass-DummyMethod-T2-(T2)-T2'></a>
-`T2`
-
-lol
-### Parameters
-
+`T2`  
+lol  
+
+#### Parameters
 <a name='Dummy-DummyClass-DummyMethod-T2-(T2)-pouet'></a>
-`pouet`
-
-kikoo
+`pouet` [T2](#Dummy-DummyClass-DummyMethod-T2-(T2)-T2 'Dummy.DummyClass.DummyMethod&lt;T2&gt;(T2).T2')  
+kikoo  
+  
diff --git a/source/Dummy/documentation/Dummy-DummyClass-DummyNested-T--Action.md b/source/Dummy/documentation/Dummy-DummyClass-DummyNested-T--Action.md
@@ -1,4 +1,8 @@
-#### [Dummy](./Dummy.md 'Dummy')
-### [Dummy](./Dummy.md#Dummy 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass').[DummyNested&lt;T&gt;](./Dummy-DummyClass-DummyNested-T-.md 'Dummy.DummyClass.DummyNested&lt;T&gt;')
-## Action `event`
-dummy
+### [Dummy](./Dummy.md 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass').[DummyClass.DummyNested&lt;T&gt;](./Dummy-DummyClass-DummyNested-T-.md 'Dummy.DummyClass.DummyNested&lt;T&gt;')
+## DummyClass.DummyNested&lt;T&gt;.Action Event
+dummy  
+```csharp
+public event Action;
+```
+#### Event type
+[System.Action&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[T](./Dummy-DummyClass-DummyNested-T-.md#Dummy-DummyClass-DummyNested-T--T 'Dummy.DummyClass.DummyNested&lt;T&gt;.T')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')
diff --git a/source/Dummy/documentation/Dummy-DummyClass-DummyNested-T-.md b/source/Dummy/documentation/Dummy-DummyClass-DummyNested-T-.md
@@ -1,21 +1,23 @@
-#### [Dummy](./Dummy.md 'Dummy')
-### [Dummy](./Dummy.md#Dummy 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
-## DummyNested&lt;T&gt; `type`
+### [Dummy](./Dummy.md 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
+## DummyClass.DummyNested&lt;T&gt; Class
 dummy `test`  
 linebreak  
 ```
+
 example
 yep
-```
-### Remarks
-pouet
-### Example
-pouet
-### Type parameters
 
+```  
+```csharp
+public class DummyClass.DummyNested<T>
+```
+Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &gt; [DummyClass.DummyNested&lt;T&gt;](./Dummy-DummyClass-DummyNested-T-.md 'Dummy.DummyClass.DummyNested&lt;T&gt;')  
+#### Type parameters
 <a name='Dummy-DummyClass-DummyNested-T--T'></a>
-`T`
-
-
+`T`  
+
+
+### Remarks
+pouet  
 ### Events
 - [Action](./Dummy-DummyClass-DummyNested-T--Action.md 'Dummy.DummyClass.DummyNested&lt;T&gt;.Action')
diff --git a/source/Dummy/documentation/Dummy-DummyClass-DummyProperty.md b/source/Dummy/documentation/Dummy-DummyClass-DummyProperty.md
@@ -1,4 +1,8 @@
-#### [Dummy](./Dummy.md 'Dummy')
-### [Dummy](./Dummy.md#Dummy 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
-## DummyProperty `property`
-dummy
+### [Dummy](./Dummy.md 'Dummy').[DummyClass](./Dummy-DummyClass.md 'Dummy.DummyClass')
+## DummyClass.DummyProperty Property
+dummy  
+```csharp
+public int DummyProperty { get; }
+```
+#### Property Value
+[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')  
diff --git a/.../documentation/Dummy-DummyClass-Equality(Dummy-DummyClass-_Dummy-DummyClass).md b/.../documentation/Dummy-DummyClass-Equality(Dummy-DummyClass-_Dummy-DummyClass).md
diff --git a/...cumentation/Dummy-DummyClass-ExclusiveOr(Dummy-DummyClass-_Dummy-DummyClass).md b/...cumentation/Dummy-DummyClass-ExclusiveOr(Dummy-DummyClass-_Dummy-DummyClass).md
diff --git a/.../documentation/Dummy-DummyClass-Explicit(Dummy-DummyClass_to_System-Double)).md b/.../documentation/Dummy-DummyClass-Explicit(Dummy-DummyClass_to_System-Double)).md
diff --git a/...y/documentation/Dummy-DummyClass-Explicit(System-Int32_to_Dummy-DummyClass)).md b/...y/documentation/Dummy-DummyClass-Explicit(System-Int32_to_Dummy-DummyClass)).md
diff --git a/...cumentation/Dummy-DummyClass-GreaterThan(Dummy-DummyClass-_Dummy-DummyClass).md b/...cumentation/Dummy-DummyClass-GreaterThan(Dummy-DummyClass-_Dummy-DummyClass).md
diff --git a/...tion/Dummy-DummyClass-GreaterThanOrEqual(Dummy-DummyClass-_Dummy-DummyClass).md b/...tion/Dummy-DummyClass-GreaterThanOrEqual(Dummy-DummyClass-_Dummy-DummyClass).md
diff --git a/...y/documentation/Dummy-DummyClass-Implicit(Dummy-DummyClass_to_System-Int32)).md b/...y/documentation/Dummy-DummyClass-Implicit(Dummy-DummyClass_to_System-Int32)).md
diff --git a/source/Dummy/documentation/Dummy-DummyClass-Increment(Dummy-DummyClass).md b/source/Dummy/documentation/Dummy-DummyClass-Increment(Dummy-DummyClass).md
diff --git a/...ocumentation/Dummy-DummyClass-Inequality(Dummy-DummyClass-_Dummy-DummyClass).md b/...ocumentation/Dummy-DummyClass-Inequality(Dummy-DummyClass-_Dummy-DummyClass).md