fixed documentation generation for dynamic keyword (fixes #14)

Doraku · Apr 10, 2020 · d0950fd · d0950fd
1 parent 74286e2
commit d0950fd
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 10 deletions.
diff --git a/source/DefaultDocumentation/DefaultDocumentation.Release.csproj b/source/DefaultDocumentation/DefaultDocumentation.Release.csproj
@@ -7,13 +7,9 @@
   </PropertyGroup>
 
   <PropertyGroup Label="Package">
-    <Version>0.6.0</Version>
+    <Version>0.6.1</Version>
     <PackageReleaseNotes>
-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
+fixed documentation generation for dynamic keyword
     </PackageReleaseNotes>
   </PropertyGroup>
 </Project>
diff --git a/source/DefaultDocumentation/DefaultDocumentation.targets b/source/DefaultDocumentation/DefaultDocumentation.targets
@@ -12,8 +12,8 @@
 
   <ItemGroup>
     <None Remove="DefaultDocumentation.targets" />
-    <Content Include="..\..\image\logo.png" PackagePath="\" Visible="false"/>
     <None Include="bin\Release\net472\*.dll" Pack="true" PackagePath="tools\" Visible="false" />
+    <Content Include="..\..\image\logo.png" PackagePath="\" Visible="false"/>
     <Content Include="build\DefaultDocumentation.targets" PackagePath="build\" />
   </ItemGroup>
 

diff --git a/source/DefaultDocumentation/DocumentationWriter.cs b/source/DefaultDocumentation/DocumentationWriter.cs
@@ -93,6 +93,7 @@ string HandleParameterizedType(ParameterizedType genericType)
                 TypeKind.Array when type is TypeWithElementType arrayType => GetTypeLink(item, arrayType.ElementType) + "System.Array".AsDotNetApiLink("[]"),
                 TypeKind.ByReference when type is TypeWithElementType innerType => GetTypeLink(item, innerType.ElementType),
                 TypeKind.TypeParameter => item.TryGetTypeParameterDocItem(type.Name, out TypeParameterDocItem typeParameter) ? GetInnerLink(typeParameter) : type.Name,
+                TypeKind.Dynamic => "[dynamic](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/types/using-type-dynamic 'dynamic')",
                 _ when type is ParameterizedType genericType => HandleParameterizedType(genericType),
                 _ => GetLink(type.GetDefinition().GetIdString())
             };

diff --git a/source/Dummy/DummyClass.cs b/source/Dummy/DummyClass.cs
@@ -42,7 +42,7 @@ public class DummyNested<T>
         /// </summary>
         /// <param name="index"></param>
         /// <returns></returns>
-        public int this[int index]
+        public dynamic this[int index]
         {
             get => index;
         }

diff --git a/source/Dummy/documentation/Dummy-DummyClass-this-int-.md b/source/Dummy/documentation/Dummy-DummyClass-this-int-.md
@@ -2,12 +2,12 @@
 ## DummyClass.this[int] Property
 dummy  
 ```csharp
-public int this[int index] { get; }
+public dynamic this[int index] { get; }
 ```
 #### Parameters
 <a name='Dummy-DummyClass-this-int--index'></a>
 `index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')  
 
 
 #### Property Value
-[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')  
+[dynamic](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/types/using-type-dynamic 'dynamic')