From b3b5a60bdbba330903afe8f5d5d18c7790e3c78c Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Sat, 29 Nov 2014 16:29:33 +1300 Subject: [PATCH] -Upgraded documentation to use latest Sandcastle -Changed documentation conceptual references to links --- Doc/ContractResolver.aml | 6 +---- Doc/ConvertingJSONandXML.aml | 6 +---- Doc/Introduction.aml | 40 ++++++++++------------------- Doc/LINQtoJSON.aml | 32 +++-------------------- Doc/Performance.aml | 9 ++----- Doc/ReadingWritingJSON.aml | 12 +-------- Doc/SerializationErrorHandling.aml | 6 +---- Doc/SerializationGuide.aml | 18 +++---------- Doc/SerializationSettings.aml | 37 +++++--------------------- Doc/SerializingJSON.aml | 6 +---- Doc/doc.shfbproj | 28 +++++++++++--------- Doc/icons/favicon.ico | Bin 0 -> 1150 bytes Doc/{ => icons}/logo.jpg | Bin 13 files changed, 50 insertions(+), 150 deletions(-) create mode 100644 Doc/icons/favicon.ico rename Doc/{ => icons}/logo.jpg (100%) diff --git a/Doc/ContractResolver.aml b/Doc/ContractResolver.aml index 2fdb0e1d..639ceeb2 100644 --- a/Doc/ContractResolver.aml +++ b/Doc/ContractResolver.aml @@ -54,11 +54,7 @@ - This example sets up - conditional serialization for a property - ConditionalProperties.htm - _self - using an IContractResolver. This is useful if you want to conditionally serialize a property but don't want to add additional methods to your type. + This example sets up conditional serialization for a property using an IContractResolver. This is useful if you want to conditionally serialize a property but don't want to add additional methods to your type. diff --git a/Doc/ConvertingJSONandXML.aml b/Doc/ConvertingJSONandXML.aml index 83e06b2f..e34ddbe3 100644 --- a/Doc/ConvertingJSONandXML.aml +++ b/Doc/ConvertingJSONandXML.aml @@ -27,11 +27,7 @@ If the XML created from JSON doesn't match what you want then you will need to convert it manually. The best approach to do this is to load your JSON into a LINQ to JSON object like JObject or JArray and then use LINQ to create an XDocument. The opposite process, using LINQ with an XDocument to create a JObject or JArray, also works. -Find out more about using LINQ to JSON with LINQ -here -QueryingLINQtoJSON.htm -_self -. +Find out more about using LINQ to JSON with LINQ here. The version of Json.NET being used in your application will change what XML conversion methods are available. diff --git a/Doc/Introduction.aml b/Doc/Introduction.aml index 0b722a56..25e4b875 100644 --- a/Doc/Introduction.aml +++ b/Doc/Introduction.aml @@ -48,21 +48,9 @@ and write from your objects. - -Serializing and Deserializing JSON -SerializingJSON.htm -_self - - -LINQ to JSON -LINQtoJSON.htm -_self - - -Samples -Samples.htm -_self - + + + @@ -105,7 +93,7 @@ and write from your objects.
Donate - Json.NET is a personal open source project. Started in 2006, I have put hundreds of hours adding, refining and tuning Json.NET with the goal to make it not just the best JSON serializer for .NET but the best serializer for any computer language. I need your + Json.NET is a personal open source project. Started in 2006, I have put thousands of hours into adding, refining and tuning Json.NET with the goal to make it not just the best JSON serializer for .NET but the best serializer for any computer language. I need your help to achieve this. @@ -117,16 +105,16 @@ and write from your objects.
- - Serializing and Deserializing JSON - SerializingJSON.htm - _self - - - LINQ to JSON - LINQtoJSON.htm - _self - + + Serializing and Deserializing JSON + SerializingJSON.htm + _self + + + LINQ to JSON + LINQtoJSON.htm + _self + Samples Samples.htm diff --git a/Doc/LINQtoJSON.aml b/Doc/LINQtoJSON.aml index c4bca7b9..a00db2e5 100644 --- a/Doc/LINQtoJSON.aml +++ b/Doc/LINQtoJSON.aml @@ -15,40 +15,16 @@ Select a topic below for more information: - - - Parsing JSON - ParsingLINQtoJSON.htm - _self - - + - - - Creating JSON - CreatingLINQtoJSON.htm - _self - - + - - - Querying JSON with LINQ - QueryingLINQtoJSON.htm - _self - - + - - - Querying JSON with SelectToken - SelectToken.htm - _self - - + diff --git a/Doc/Performance.aml b/Doc/Performance.aml index 751daf65..0f0e8168 100644 --- a/Doc/Performance.aml +++ b/Doc/Performance.aml @@ -59,13 +59,8 @@ - If performance is important and you don't mind more code to get it then this is your best choice. Read more about using JsonReader/JsonWriter here: - - Basic Reading and Writing JSON - ReadingWritingJSON.aml - _self - - + + If performance is important and you don't mind more code to get it then this is your best choice. Read more about using JsonReader/JsonWriter here: diff --git a/Doc/ReadingWritingJSON.aml b/Doc/ReadingWritingJSON.aml index d9f0f9bf..fb9731e5 100644 --- a/Doc/ReadingWritingJSON.aml +++ b/Doc/ReadingWritingJSON.aml @@ -14,17 +14,7 @@ JsonReader and JsonWriter are low level classes and used internally by Json.NET. - To quickly work with JSON either the serializer - - - Serializing and Deserializing JSON - SerializingJSON.htm - _self - - or using - LINQ to JSON - LINQtoJSON.htm - _self - is recommended. + To quickly work with JSON either the serializer - or using is recommended. diff --git a/Doc/SerializationErrorHandling.aml b/Doc/SerializationErrorHandling.aml index 5ed03358..cf00dcbf 100644 --- a/Doc/SerializationErrorHandling.aml +++ b/Doc/SerializationErrorHandling.aml @@ -73,11 +73,7 @@ The T:Newtonsoft.Json.Serialization.OnErrorAttribute - works much like the other -.NET serialization attributes -SerializationAttributes.htm -_self - + works much like the other .NET serialization attributes that Json.NET supports. To use it you simply place the attribute on a method which takes the correct parameters: a StreamingContext and a ErrorContext. The name of the method doesn't diff --git a/Doc/SerializationGuide.aml b/Doc/SerializationGuide.aml index 5b7489b6..e71c1604 100644 --- a/Doc/SerializationGuide.aml +++ b/Doc/SerializationGuide.aml @@ -92,11 +92,7 @@ DateTime - String ( -Serializing Dates in JSON -DatesInJSON.htm -_self -) + String () @@ -171,11 +167,7 @@ $values property which will have the collection data. When deserializing if a member is typed as the interface IList<T> then it will be deserialized as a List<T>. - Read more about serializing collections here: -Serializing Collections -SerializingCollections.htm -_self - + Read more about serializing collections here: @@ -197,11 +189,7 @@ handling that are applied to collection items. When deserializing if a member is typed as the interface IDictionary<TKey, TValue> then it will be deserialized as a Dictionary<TKey, TValue>. - Read more about serializing collections here: -Serializing Collections -SerializingCollections.htm -_self - + Read more about serializing collections here: diff --git a/Doc/SerializationSettings.aml b/Doc/SerializationSettings.aml index 029f62c4..86d76763 100644 --- a/Doc/SerializationSettings.aml +++ b/Doc/SerializationSettings.aml @@ -303,21 +303,9 @@ or a property's object properties or collection items using To create your own custom converter inherit from the JsonConverter class. Read more about the built-in JsonConverters below: - -Serializing Dates in JSON -DatesInJSON.htm -_self - - -Converting between JSON and XML -ConvertingJSONandXML.htm -_self - - -CustomCreationConverter -CustomCreationConverter.htm -_self - + + + T:Newtonsoft.Json.Converters.StringEnumConverter @@ -330,11 +318,7 @@ or a property's object properties or collection items using Internally for every .NET type the JsonSerializer will create a contract of how the type should be serialized and deserialized, based on type metadata and attributes applied to the class. Specifying a custom T:Newtonsoft.Json.Serialization.IContractResolver allows the creation of contracts to be customized. - Read more about Contract Resolvers here: -Contract Resolvers -ContractResolver.htm -_self - + Read more about Contract Resolvers here: @@ -343,11 +327,7 @@ or a property's object properties or collection items using The Json.NET serializer supports logging and debugging using the T:Newtonsoft.Json.Serialization.ITraceWriter interface. By assigning a trace writer you can debug what happens inside the Json.NET serializer when serializing and deserializing JSON. - Read more about TraceWriters here: -Debugging with Serialization Tracing -SerializationTracing.htm -_self - + Read more about TraceWriters here: @@ -355,12 +335,7 @@ or a property's object properties or collection items using Error The E:Newtonsoft.Json.JsonSerializer.Error event can catch errors during serialization and either handle the event and continue with serialization or let the error bubble up and be thrown to the application. - Read more about error handling here: -Serialization Error Handling -SerializationErrorHandling.htm -_self - - + Read more about error handling here: diff --git a/Doc/SerializingJSON.aml b/Doc/SerializingJSON.aml index da7820b6..014f657a 100644 --- a/Doc/SerializingJSON.aml +++ b/Doc/SerializingJSON.aml @@ -42,11 +42,7 @@ LINQ to JSON objects or JsonSerializer has a number of properties on it to customize how it serializes JSON. These can also be used with the methods on JsonConvert via the JsonSerializerSettings overloads. -Read more about the available JsonSerializer settings here: -Serialization Settings -SerializationSettings.htm -_self - +Read more about the available JsonSerializer settings here: diff --git a/Doc/doc.shfbproj b/Doc/doc.shfbproj index 4b8741cc..68a8948e 100644 --- a/Doc/doc.shfbproj +++ b/Doc/doc.shfbproj @@ -32,9 +32,9 @@ Website - .NET Framework 4.5.1 - Json.NET - Documentation - VS2005 + .NET Framework 4.5 + Json.NET Documentation + VS2013 MemberName ..\Src\Newtonsoft.Json\bin\Release @@ -57,12 +57,12 @@ - - {@HelpFormatOutputPaths} - - - - + + {@HelpFormatOutputPaths} + + + + False @@ -71,7 +71,7 @@ False False True - CSharp + C# Blank False en-US @@ -84,6 +84,8 @@ + 2 + False @@ -95,6 +97,7 @@ + @@ -247,12 +250,13 @@ performance performance - + logo logo - + + diff --git a/Doc/icons/favicon.ico b/Doc/icons/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..8e7eac975b7461495659faa08730c0c286755682 GIT binary patch literal 1150 zcmZQzU<5(|0R|wcz>vYhz#zuJz@P!dKp~(AL>x#lFaYJSfd4=-%JBWo{~5@^Fnh_- z3(|v2zqJ8E4#Yk<8@v0k=`W9m=mpVj*$}pz1o8TpG(+_0szCJc^Fa8U`Z3MGW6mj7pf`5zRn=wX8|{6OIilZVluI7K!CCXOsd3VX2Vhq;418cUHtybu62NeKi1 literal 0 HcmV?d00001 diff --git a/Doc/logo.jpg b/Doc/icons/logo.jpg similarity index 100% rename from Doc/logo.jpg rename to Doc/icons/logo.jpg