From d2be7d2f32e9eb83a07b0aac904cb953a8c1781a Mon Sep 17 00:00:00 2001 From: Kent Johnson Date: Tue, 23 Oct 2018 08:10:25 -0500 Subject: [PATCH] Converted InheritDocLib to a shared project --- InheritDoc.sln | 15 ++++---- InheritDoc/InheritDoc.csproj | 13 ++++--- InheritDocLib/InheritDocLib.csproj | 34 ------------------- InheritDocLib/InheritDocLib.projitems | 22 ++++++++++++ InheritDocLib/InheritDocLib.shproj | 13 +++++++ InheritDocLib/Key.snk | Bin 596 -> 0 bytes InheritDocLib/packages.config | 5 --- InheritDocTest/InheritDocTest.csproj | 21 ++++++++---- InheritDocTest/packages.config | 3 +- InheritDocVsix/InheritDocVsix.csproj | 23 ++++++++----- InheritDocVsix/packages.config | 1 + InheritDocVsix/source.extension.vsixmanifest | 10 ++---- generate-nuget-packages.ps1 | 2 +- www.inheritdoc.io/index.html | 24 ++++--------- 14 files changed, 91 insertions(+), 95 deletions(-) delete mode 100644 InheritDocLib/InheritDocLib.csproj create mode 100644 InheritDocLib/InheritDocLib.projitems create mode 100644 InheritDocLib/InheritDocLib.shproj delete mode 100644 InheritDocLib/Key.snk delete mode 100644 InheritDocLib/packages.config diff --git a/InheritDoc.sln b/InheritDoc.sln index 96d7c1c..510768d 100644 --- a/InheritDoc.sln +++ b/InheritDoc.sln @@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 VisualStudioVersion = 15.0.27130.2010 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "InheritDoc", "InheritDoc\InheritDoc.csproj", "{8D70AD37-9599-474B-B231-5447DDFBFD31}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "InheritDoc", "InheritDoc\InheritDoc.csproj", "{8D70AD37-9599-474B-B231-5447DDFBFD31}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{31F77A66-10E2-4705-B16D-9A2DDB6ED1C2}" ProjectSection(SolutionItems) = preProject @@ -13,8 +13,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution release.txt = release.txt EndProjectSection EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "InheritDocLib", "InheritDocLib\InheritDocLib.csproj", "{390F170D-8730-4114-A3DA-EDA42541DA86}" -EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "InheritDocTest", "InheritDocTest\InheritDocTest.csproj", "{CA4B94C3-0C7A-4392-A20F-79A60C7CB38A}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "InheritDocVsix", "InheritDocVsix\InheritDocVsix.csproj", "{ACA5ADAF-6AC8-4EB7-A417-AEB141C102CD}" @@ -40,7 +38,14 @@ Project("{E24C65DC-7377-472B-9ABA-BC803B73C61A}") = "www.inheritdoc.io", "www.in SlnRelativePath = "www.inheritdoc.io\" EndProjectSection EndProject +Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "InheritDocLib", "InheritDocLib\InheritDocLib.shproj", "{49BBB881-A047-4A28-9586-D5FFFA083806}" +EndProject Global + GlobalSection(SharedMSBuildProjectFiles) = preSolution + InheritDocLib\InheritDocLib.projitems*{49bbb881-a047-4a28-9586-d5fffa083806}*SharedItemsImports = 13 + InheritDocLib\InheritDocLib.projitems*{aca5adaf-6ac8-4eb7-a417-aeb141c102cd}*SharedItemsImports = 4 + InheritDocLib\InheritDocLib.projitems*{ca4b94c3-0c7a-4392-a20f-79a60c7cb38a}*SharedItemsImports = 4 + EndGlobalSection GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU Release|Any CPU = Release|Any CPU @@ -50,10 +55,6 @@ Global {8D70AD37-9599-474B-B231-5447DDFBFD31}.Debug|Any CPU.Build.0 = Debug|Any CPU {8D70AD37-9599-474B-B231-5447DDFBFD31}.Release|Any CPU.ActiveCfg = Release|Any CPU {8D70AD37-9599-474B-B231-5447DDFBFD31}.Release|Any CPU.Build.0 = Release|Any CPU - {390F170D-8730-4114-A3DA-EDA42541DA86}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {390F170D-8730-4114-A3DA-EDA42541DA86}.Debug|Any CPU.Build.0 = Debug|Any CPU - {390F170D-8730-4114-A3DA-EDA42541DA86}.Release|Any CPU.ActiveCfg = Release|Any CPU - {390F170D-8730-4114-A3DA-EDA42541DA86}.Release|Any CPU.Build.0 = Release|Any CPU {CA4B94C3-0C7A-4392-A20F-79A60C7CB38A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {CA4B94C3-0C7A-4392-A20F-79A60C7CB38A}.Debug|Any CPU.Build.0 = Debug|Any CPU {CA4B94C3-0C7A-4392-A20F-79A60C7CB38A}.Release|Any CPU.ActiveCfg = Release|Any CPU diff --git a/InheritDoc/InheritDoc.csproj b/InheritDoc/InheritDoc.csproj index 96c8c4e..9d0ac98 100644 --- a/InheritDoc/InheritDoc.csproj +++ b/InheritDoc/InheritDoc.csproj @@ -1,7 +1,7 @@  - 2.0.0.0 + 2.0.1 Command line tool that post processes XML documentation files to support an tag allowing inheriting XML comments from base types, interfaces, and similar methods. Works with .NET Framework, .NET Standard, and .NET Core projects. See the separate InheritDocLib NuGet package for a programmatic interface. Fireshark Studios, LLC Copyright © 2017-2018 @@ -14,7 +14,7 @@ Exe - Converted InheritDocLib to support both .NET Core and .NET Framework + Changed InheritDocLib to shared project to avoid loading issues for VSIX @@ -41,11 +41,8 @@ - - - - - + + @@ -58,4 +55,6 @@ + + \ No newline at end of file diff --git a/InheritDocLib/InheritDocLib.csproj b/InheritDocLib/InheritDocLib.csproj deleted file mode 100644 index a3fb483..0000000 --- a/InheritDocLib/InheritDocLib.csproj +++ /dev/null @@ -1,34 +0,0 @@ - - - - netstandard2.0;net45 - bin\$(Configuration)\$(TargetFramework)\$(MSBuildProjectName).xml - true - Key.snk - false - 2.0.0.0 - Library that post processes XML documentation files to support an tag allowing inheriting XML comments from base types, interfaces, and similar methods. Works with .NET Framework, .NET Standard, and .NET Core projects. See the separate InheritDoc NuGet package for a command line interface. - Fireshark Studios, LLC - Copyright © 2017-2018 - InheritDoc - Fireshark Studios, LLC - https://www.inheritdoc.io/license/ - https://www.inheritdoc.io/ - inherit, copy, xml, inheritdoclib, extend, comments - https://www.inheritdoc.io/img/logo_256x256.png - Converted InheritDocLib to support both .NET Core and .NET Framework - - - - latest - - - - - - - - - - - diff --git a/InheritDocLib/InheritDocLib.projitems b/InheritDocLib/InheritDocLib.projitems new file mode 100644 index 0000000..a1238a0 --- /dev/null +++ b/InheritDocLib/InheritDocLib.projitems @@ -0,0 +1,22 @@ + + + + $(MSBuildAllProjects);$(MSBuildThisFileFullPath) + true + 49bbb881-a047-4a28-9586-d5fffa083806 + + + InheritDocLib + + + + + + + + + + + + + \ No newline at end of file diff --git a/InheritDocLib/InheritDocLib.shproj b/InheritDocLib/InheritDocLib.shproj new file mode 100644 index 0000000..7b284a7 --- /dev/null +++ b/InheritDocLib/InheritDocLib.shproj @@ -0,0 +1,13 @@ + + + + 49bbb881-a047-4a28-9586-d5fffa083806 + 14.0 + + + + + + + + diff --git a/InheritDocLib/Key.snk b/InheritDocLib/Key.snk deleted file mode 100644 index e6bff4479bc76425cdb5ae9bd428ccc9c1291cc5..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 596 zcmV-a0;~N80ssI2Bme+XQ$aES1ONa50098G5}W^d#1uso@mf9tq|R&r9p?GoA<(jV z)^nd8D4CE(IK|KB{MN5B3U(qo*@I*==Ju_i2ILINCr`FuPQL`-;r;ydH)wAF%>37t z+h$HRs~(5#C3)eI+<({|WvndrC-<^3)3IT?0cJ(W-b$_c{5$cp0)c5gxuUT?o`&fs zZ6mf$B;{hqIDA-tyq9%OWw zt&H<+T^4yN$2t$;GsM0Dyay>d9?sG-_gw@ObtnAGY_y&QtVc=#3$@@$2qe4sJQRQ-abpO2AWR(DqT~4UAH;*bAc#Fh5Houdu=AO iRw>^NHspB-HIs)#ti10s1!F_Z5f_3_^Z1cv29=Vfg&h0< diff --git a/InheritDocLib/packages.config b/InheritDocLib/packages.config deleted file mode 100644 index 9c17fad..0000000 --- a/InheritDocLib/packages.config +++ /dev/null @@ -1,5 +0,0 @@ - - - - - \ No newline at end of file diff --git a/InheritDocTest/InheritDocTest.csproj b/InheritDocTest/InheritDocTest.csproj index d336118..3cd7432 100644 --- a/InheritDocTest/InheritDocTest.csproj +++ b/InheritDocTest/InheritDocTest.csproj @@ -47,8 +47,20 @@ ..\packages\MSTest.TestFramework.1.1.18\lib\net45\Microsoft.VisualStudio.TestPlatform.TestFramework.Extensions.dll + + ..\packages\Mono.Cecil.0.10.1\lib\net40\Mono.Cecil.dll + + + ..\packages\Mono.Cecil.0.10.1\lib\net40\Mono.Cecil.Mdb.dll + + + ..\packages\Mono.Cecil.0.10.1\lib\net40\Mono.Cecil.Pdb.dll + + + ..\packages\Mono.Cecil.0.10.1\lib\net40\Mono.Cecil.Rocks.dll + - ..\packages\NLog.4.5.8\lib\net45\NLog.dll + ..\packages\NLog.4.5.10\lib\net45\NLog.dll @@ -71,12 +83,6 @@ - - - {390f170d-8730-4114-a3da-eda42541da86} - InheritDocLib - - @@ -87,4 +93,5 @@ + \ No newline at end of file diff --git a/InheritDocTest/packages.config b/InheritDocTest/packages.config index 562462e..193d225 100644 --- a/InheritDocTest/packages.config +++ b/InheritDocTest/packages.config @@ -1,7 +1,8 @@  + - + \ No newline at end of file diff --git a/InheritDocVsix/InheritDocVsix.csproj b/InheritDocVsix/InheritDocVsix.csproj index bd14f8d..cdf4e47 100644 --- a/InheritDocVsix/InheritDocVsix.csproj +++ b/InheritDocVsix/InheritDocVsix.csproj @@ -160,6 +160,18 @@ ..\packages\Microsoft.VisualStudio.Validation.15.3.15\lib\net45\Microsoft.VisualStudio.Validation.dll + + ..\packages\Mono.Cecil.0.10.1\lib\net40\Mono.Cecil.dll + + + ..\packages\Mono.Cecil.0.10.1\lib\net40\Mono.Cecil.Mdb.dll + + + ..\packages\Mono.Cecil.0.10.1\lib\net40\Mono.Cecil.Pdb.dll + + + ..\packages\Mono.Cecil.0.10.1\lib\net40\Mono.Cecil.Rocks.dll + @@ -172,6 +184,7 @@ + @@ -180,13 +193,6 @@ VSPackage - - - {390f170d-8730-4114-a3da-eda42541da86} - InheritDocLib - False - - @@ -198,7 +204,8 @@ - + + - diff --git a/generate-nuget-packages.ps1 b/generate-nuget-packages.ps1 index 3a76992..473c5c2 100644 --- a/generate-nuget-packages.ps1 +++ b/generate-nuget-packages.ps1 @@ -1,3 +1,3 @@ dotnet pack -c Release -o \NuGet.local .\InheritDoc dotnet pack -c Release -o \NuGet.local .\InheritDoc /p:GlobalTool=true -dotnet pack -c Release -o \NuGet.local .\InheritDocLib \ No newline at end of file +#dotnet pack -c Release -o \NuGet.local .\InheritDocLib \ No newline at end of file diff --git a/www.inheritdoc.io/index.html b/www.inheritdoc.io/index.html index 991cd4c..4966b22 100644 --- a/www.inheritdoc.io/index.html +++ b/www.inheritdoc.io/index.html @@ -64,7 +64,7 @@

InheritDoc

Inherit XML comments in your C# source code.

- Build a real-time web app using C# on the server and Vue.js on the client -- checkout Butterfly Server .NET on GitHub + Build a real-time web app using C# on the server and Vue.js on the client -- checkout Butterfly Server .NET on GitHub

Overview

@@ -368,9 +368,9 @@

InheritDoc

  • Run InheritDoc by entering this in the Package Manager Console... - 
    .\packages\InheritDoc.2.0.0\tools\InheritDoc
    + 
    .\packages\InheritDoc.2.0.1\tools\InheritDoc

    -or-

    - 
    \Users\<your user name>\.nuget\packages\inheritdoc\2.0.0\tools\InheritDoc.exe
    + 
    \Users\<your user name>\.nuget\packages\inheritdoc\2.0.1\tools\InheritDoc.exe

    The path depends on the type of project (.NET Framework vs .NET Standard/Core).

    • @@ -507,13 +507,14 @@

    FAQ

    - I'm using a -g switch to extend the documentation on a System class, how can I exlude the XML comments for System.Object? + I'm using a -g switch to extend the documentation on a System class, how can I exclude the XML comments for System.Object?
    -

    Use the -x switch with a comma delimited list of classes to exclude inheriting from (like -xSystem.Object)

    +

    Use the -x switch with a comma delimited list of classes to exclude from inheriting from (like -xSystem.Object)

    Release Notes

      +
    • v2.0.1 (10/23/2018) - Changed InheritDocLib to shared project to avoid loading issues for VSIX
    • v2.0.0 (8/23/2018) - Converted InheritDocLib to also target .NET Core (thanks johan-v-r)
    • v1.2.3 (8/21/2018) - Upgraded to latest version of Mono.Cecil
    • v1.2.2.1 (8/12/2018) - Fixed issue not finding base types in cref attributes searching global source xml files
      • @@ -536,7 +537,7 @@

      Contact Me

      Contact me at kent@fireshark.com if you have any questions, concerns, or ideas.

    - Build a real-time web app using C# on the server and Vue.js on the client -- checkout Butterfly Server .NET on GitHub + Build a real-time web app using C# on the server and Vue.js on the client -- checkout Butterfly Server .NET on GitHub

    Copyright 2017-2018, Fireshark Studios, LLC

    @@ -572,17 +573,6 @@

    Contact Me

    } }); - /* - document.getElementById('pay-now-button').addEventListener('click', function (e) { - handler.open({ - name: 'Fireshark Studios, LLC', - description: 'Inherit Doc Pro Edition', - amount: 2900 - }); - e.preventDefault(); - }); - */ - window.addEventListener('popstate', function () { handler.close(); });