Update NuDoc; prepare for version 2.3

peteroupc · Dec 12, 2015 · f25f57c · f25f57c
1 parent 5fbf253
commit f25f57c
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 36 deletions.
diff --git a/CBOR.nuspec b/CBOR.nuspec
@@ -2,10 +2,10 @@
 <package>
   <metadata>
     <id>PeterO.Cbor</id>
-    <version>$version$</version>
+    <version>2.3.0</version>
     <title>CBOR</title>
-    <authors>$author$</authors>
-    <owners>$author$</owners>
+    <authors>Peter Occil</authors>
+    <owners>Peter Occil</owners>
     <licenseUrl>http://creativecommons.org/publicdomain/zero/1.0/</licenseUrl>
     <projectUrl>https://github.com/peteroupc/CBOR</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
@@ -16,9 +16,14 @@
     </description>
     <summary>A C# implementation of Concise Binary Object Representation (CBOR), a data serialization format. This implementation can also convert between CBOR and JSON.</summary>
     <releaseNotes>
-In version 2.2:
-- Portable Class Library compatibility expanded
-- Add option to always use definite length string encoding when generating CBOR objects
+In version 2.3:
+- The C# version of the library now also targets "dotnet", which should make it compatible with platform .NET runtime
+environments such as the upcoming cross-platform "coreclr" runtime.
+- Added GetUtf8Bytes overload to DataUtilities
+- Fixed line break bug when setting lenientLineBreaks to true in the PeterO.Cbor.DataUtilities.WriteUtf8 method
+- In BigInteger, fixed divideAndRemainder method, added certain methods and made other methods obsolete
+- Many additions to the documentation
+- Other bug fixes
 See the project page for release notes on previous versions: https://github.com/peteroupc/CBOR
     </releaseNotes>
     <copyright>Written by Peter O. in 2013-2015.  Any copyright is released to the Public Domain.</copyright>

diff --git a/CBORDocs/CBORDocs.csproj b/CBORDocs/CBORDocs.csproj
@@ -42,8 +42,9 @@
     <StartupObject />
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="ClariusLabs.NuDoc">
-      <HintPath>..\packages\NuDoc.0.4.1308.1316\lib\net35\ClariusLabs.NuDoc.dll</HintPath>
+    <Reference Include="NuDoq, Version=1.2.0.0, Culture=neutral, PublicKeyToken=197ef17e56afcdb9, processorArchitecture=MSIL">
+      <HintPath>..\packages\NuDoq.1.2.5\lib\net35\NuDoq.dll</HintPath>
+      <Private>True</Private>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
@@ -71,11 +72,4 @@
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Import Project="$(MSBuildExtensionsPath)\StyleCop\v4.7\StyleCop.targets" />
-  <Import Project="..\packages\NuSpec.ReferenceGenerator.1.4.0\build\dotnet\NuSpec.ReferenceGenerator.targets" Condition="Exists('..\packages\NuSpec.ReferenceGenerator.1.4.0\build\dotnet\NuSpec.ReferenceGenerator.targets')" />
-  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
-    <PropertyGroup>
-      <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
-    </PropertyGroup>
-    <Error Condition="!Exists('..\packages\NuSpec.ReferenceGenerator.1.4.0\build\dotnet\NuSpec.ReferenceGenerator.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\NuSpec.ReferenceGenerator.1.4.0\build\dotnet\NuSpec.ReferenceGenerator.targets'))" />
-  </Target>
 </Project>
diff --git a/CBORDocs/DocGenerator.cs b/CBORDocs/DocGenerator.cs
@@ -3,7 +3,7 @@
 using System.Linq;
 using System.Reflection;
 using System.Text;
-using ClariusLabs.NuDoc;
+using NuDoq;
 
 namespace PeterO.DocGen {
 /// <summary>A documentation generator.</summary>

diff --git a/CBORDocs/DocVisitor.cs b/CBORDocs/DocVisitor.cs
@@ -13,7 +13,7 @@ Any copyright is dedicated to the Public Domain.
 using System.Text;
 using System.Text.RegularExpressions;
 
-using ClariusLabs.NuDoc;
+using NuDoq;
 
 namespace PeterO.DocGen {
     /// <summary>A documentation visitor.</summary>
@@ -484,7 +484,7 @@ public override void VisitExample(Example example) {
       this.WriteLine("\r\n\r\n");
     }
 
-    public override void VisitException(ClariusLabs.NuDoc.Exception exception) {
+    public override void VisitException(NuDoq.Exception exception) {
       using (var ch = this.Change(this.exceptionStr)) {
         var cref = exception.Cref;
         if (cref.StartsWith("T:", StringComparison.Ordinal)) {

diff --git a/CBORDocs/SummaryVisitor.cs b/CBORDocs/SummaryVisitor.cs
@@ -13,7 +13,7 @@ Any copyright is dedicated to the Public Domain.
 using System.Text;
 using System.Text.RegularExpressions;
 
-using ClariusLabs.NuDoc;
+using NuDoq;
 
 namespace PeterO.DocGen {
   internal class SummaryVisitor : Visitor, IComparer<Type> {

diff --git a/CBORDocs/TypeVisitor.cs b/CBORDocs/TypeVisitor.cs
@@ -13,7 +13,7 @@ Any copyright is dedicated to the Public Domain.
 using System.Text;
 using System.Text.RegularExpressions;
 
-using ClariusLabs.NuDoc;
+using NuDoq;
 
 namespace PeterO.DocGen {
   internal class TypeVisitor : Visitor, IComparer<Type> {

diff --git a/CBORDocs/packages.config b/CBORDocs/packages.config
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="NuDoc" version="0.4.1308.1316" targetFramework="net45" />
-  <package id="NuSpec.ReferenceGenerator" version="1.4.0" targetFramework="net45" developmentDependency="true" />
+  <package id="NuDoc" version="0.5" targetFramework="net45" />
+  <package id="NuDoq" version="1.2.5" targetFramework="net45" />
 </packages>
diff --git a/CBORDocs2/CBORDocs2.csproj b/CBORDocs2/CBORDocs2.csproj
@@ -41,7 +41,6 @@
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />
-    <None Include="packages.config" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\CBORDocs\CBORDocs.csproj">
@@ -58,11 +57,4 @@
   </Target>
   -->
   <Import Project="$(MSBuildExtensionsPath)\StyleCop\v4.7\StyleCop.targets" />
-  <Import Project="..\packages\NuSpec.ReferenceGenerator.1.4.0\build\dotnet\NuSpec.ReferenceGenerator.targets" Condition="Exists('..\packages\NuSpec.ReferenceGenerator.1.4.0\build\dotnet\NuSpec.ReferenceGenerator.targets')" />
-  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
-    <PropertyGroup>
-      <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
-    </PropertyGroup>
-    <Error Condition="!Exists('..\packages\NuSpec.ReferenceGenerator.1.4.0\build\dotnet\NuSpec.ReferenceGenerator.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\NuSpec.ReferenceGenerator.1.4.0\build\dotnet\NuSpec.ReferenceGenerator.targets'))" />
-  </Target>
 </Project>
diff --git a/CBORDocs2/packages.config b/CBORDocs2/packages.config
diff --git a/CBORTest/TestCommon.cs b/CBORTest/TestCommon.cs
@@ -469,8 +469,8 @@ public static string ObjectMessages(
       object o1,
       object o2,
       String s) {
-        CBORObject co1 = o1 as CBORObject;
-        CBORObject co2 = o2 as CBORObject;
+        var co1 = o1 as CBORObject;
+        var co2 = o2 as CBORObject;
       if (co1 != null) {
         TestCommon.ObjectMessages(co1, co2, s);
       }

diff --git a/README.md b/README.md
@@ -233,6 +233,16 @@ The following are some clarifications to RFC 7049.
 Release Notes
 -----------
 
+In version 2.3:
+
+- The C# version of the library now also targets "dotnet", which should make it compatible with platform .NET runtime
+environments such as the upcoming cross-platform "coreclr" runtime.
+- Added GetUtf8Bytes overload to DataUtilities
+- Fixed line break bug when setting lenientLineBreaks to true in the PeterO.Cbor.DataUtilities.WriteUtf8 method
+- In BigInteger, fixed divideAndRemainder method, added certain methods and made other methods obsolete
+- Many additions to the documentation
+- Other bug fixes
+
 In version 2.2:
 - Portable Class Library compatibility expanded
 - Add option to always use definite length string encoding when generating CBOR objects