LiRuochen_WorkFlow/Newtonsoft.Json
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

-Upgraded documentation to use latest Sandcastle

Browse Source 
-Changed documentation conceptual references to links
This commit is contained in:
James Newton-King
2014-11-29 16:29:33 +13:00
parent fea3ffddeb
commit b3b5a60bdb
13 changed files with 50 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Doc/ContractResolver.aml
+1 -5
View File
@@ -54,11 +54,7 @@
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\ConditionalPropertiesTests.cs" region="ShouldSerializeContractResolver" title="Conditional properties with IContractResolver" />
<para>This example sets up <externalLink>
<linkText>conditional serialization for a property</linkText>
<linkUri>ConditionalProperties.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink> 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.</para>
<para>This example sets up <link xlink:href="ConditionalProperties">conditional serialization for a property</link> 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.</para>
</content>
</section>
<relatedTopics>
Doc/ConvertingJSONandXML.aml
+1 -5
View File
@@ -27,11 +27,7 @@
<para>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 <externalLink>
<linkText>here</linkText>
<linkUri>QueryingLINQtoJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>.</para>
Find out more about using LINQ to JSON with LINQ <link xlink:href="QueryingLINQtoJSON">here</link>.</para>
<alert class="note">
<para>The version of Json.NET being used in your application will change what XML conversion methods are available.
Doc/Introduction.aml
+14 -26
View File
@@ -48,21 +48,9 @@ and write from your objects.</para>
<content>
<list class="bullet">
<listItem><para><externalLink>
<linkText>Serializing and Deserializing JSON</linkText>
<linkUri>SerializingJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para></listItem>
<listItem><para><externalLink>
<linkText>LINQ to JSON</linkText>
<linkUri>LINQtoJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para></listItem>
<listItem><para><externalLink>
<linkText>Samples</linkText>
<linkUri>Samples.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para></listItem>
<listItem><para><link xlink:href="SerializingJSON" /></para></listItem>
<listItem><para><link xlink:href="LINQtoJSON" /></para></listItem>
<listItem><para><link xlink:href="Samples" /></para></listItem>
</list>
</content>
@@ -105,7 +93,7 @@ and write from your objects.</para>
<section>
<title>Donate</title>
<content><para>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
<content><para>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.</para>
<markup>
@@ -117,16 +105,16 @@ and write from your objects.</para>
</section>
<relatedTopics>
<externalLink>
<linkText>Serializing and Deserializing JSON</linkText>
<linkUri>SerializingJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
<externalLink>
<linkText>LINQ to JSON</linkText>
<linkUri>LINQtoJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
<externalLink>
<linkText>Serializing and Deserializing JSON</linkText>
<linkUri>SerializingJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
<externalLink>
<linkText>LINQ to JSON</linkText>
<linkUri>LINQtoJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
<externalLink>
<linkText>Samples</linkText>
<linkUri>Samples.htm</linkUri>
Doc/LINQtoJSON.aml
+4 -28
View File
@@ -15,40 +15,16 @@
<para>Select a topic below for more information:</para>
<list class="bullet">
<listItem>
<para>
<externalLink>
<linkText>Parsing JSON</linkText>
<linkUri>ParsingLINQtoJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
</para>
<para><link xlink:href="ParsingLINQtoJSON" /></para>
</listItem>
<listItem>
<para>
<externalLink>
<linkText>Creating JSON</linkText>
<linkUri>CreatingLINQtoJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
</para>
<para><link xlink:href="CreatingLINQtoJSON" /></para>
</listItem>
<listItem>
<para>
<externalLink>
<linkText>Querying JSON with LINQ</linkText>
<linkUri>QueryingLINQtoJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
</para>
<para><link xlink:href="QueryingLINQtoJSON" /></para>
</listItem>
<listItem>
<para>
<externalLink>
<linkText>Querying JSON with SelectToken</linkText>
<linkUri>SelectToken.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
</para>
<para><link xlink:href="SelectToken" /></para>
</listItem>
</list>
</content>
Doc/Performance.aml
+2 -7
View File
@@ -59,13 +59,8 @@
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\PerformanceTests.cs" region="ReaderWriter" title="Manually serialize using JsonTextWriter" />
<para>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:
<externalLink>
<linkText>Basic Reading and Writing JSON</linkText>
<linkUri>ReadingWritingJSON.aml</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
<para>
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: <link xlink:href="ReadingWritingJSON" />
</para>
</content>
</section>
Doc/ReadingWritingJSON.aml
+1 -11
View File
@@ -14,17 +14,7 @@
<alert class="note">
<para>JsonReader and JsonWriter are low level classes and used internally by Json.NET.
To quickly work with JSON either the serializer -
<externalLink>
<linkText>Serializing and Deserializing JSON</linkText>
<linkUri>SerializingJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
or using <externalLink>
<linkText>LINQ to JSON</linkText>
<linkUri>LINQtoJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink> is recommended.
To quickly work with JSON either the serializer - <link xlink:href="SerializingJSON" /> or using <link xlink:href="LINQtoJSON" /> is recommended.
</para>
</alert>
Doc/SerializationErrorHandling.aml
+1 -5
View File
@@ -73,11 +73,7 @@
<!-- Uncomment this to create a sub-section outline
<autoOutline /> -->
<para>The <codeEntityReference>T:Newtonsoft.Json.Serialization.OnErrorAttribute</codeEntityReference>
works much like the other <externalLink>
<linkText>.NET serialization attributes</linkText>
<linkUri>SerializationAttributes.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
works much like the other <link xlink:href="SerializationAttributes">.NET serialization attributes</link>
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
Doc/SerializationGuide.aml
+3 -15
View File
@@ -92,11 +92,7 @@
<entry>
<para><legacyBold>DateTime</legacyBold></para>
</entry>
<entry><para>String (<externalLink>
<linkText>Serializing Dates in JSON</linkText>
<linkUri>DatesInJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>)</para></entry>
<entry><para>String (<link xlink:href="DatesInJSON" />)</para></entry>
</row>
<row>
<entry>
@@ -171,11 +167,7 @@
$values property which will have the collection data.</para>
<para>When deserializing if a member is typed as the interface IList&lt;T&gt; then it will be deserialized as a
List&lt;T&gt;.</para>
<para>Read more about serializing collections here: <externalLink>
<linkText>Serializing Collections</linkText>
<linkUri>SerializingCollections.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para>
<para>Read more about serializing collections here: <link xlink:href="SerializingCollections" /></para>
</content>
</section>
@@ -197,11 +189,7 @@
handling that are applied to collection items.</para>
<para>When deserializing if a member is typed as the interface IDictionary&lt;TKey, TValue&gt; then it will be
deserialized as a Dictionary&lt;TKey, TValue&gt;.</para>
<para>Read more about serializing collections here: <externalLink>
<linkText>Serializing Collections</linkText>
<linkUri>SerializingCollections.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para>
<para>Read more about serializing collections here: <link xlink:href="SerializingCollections" /></para>
</content>
</section>
Doc/SerializationSettings.aml
+6 -31
View File
@@ -303,21 +303,9 @@ or a property's object properties or collection items using
<para>To create your own custom converter inherit from the JsonConverter class. Read more about the built-in JsonConverters below:</para>
<list class="bullet">
<listItem><para><externalLink>
<linkText>Serializing Dates in JSON</linkText>
<linkUri>DatesInJSON.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para></listItem>
<listItem><para><externalLink>
<linkText>Converting between JSON and XML</linkText>
<linkUri>ConvertingJSONandXML.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para></listItem>
<listItem><para><externalLink>
<linkText>CustomCreationConverter</linkText>
<linkUri>CustomCreationConverter.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para></listItem>
<listItem><para><link xlink:href="DatesInJSON" /></para></listItem>
<listItem><para><link xlink:href="ConvertingJSONandXML" /></para></listItem>
<listItem><para><link xlink:href="CustomCreationConverter" /></para></listItem>
<listItem><para><codeEntityReference>T:Newtonsoft.Json.Converters.StringEnumConverter</codeEntityReference></para></listItem>
</list>
@@ -330,11 +318,7 @@ or a property's object properties or collection items using
<content><para>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 <codeEntityReference>T:Newtonsoft.Json.Serialization.IContractResolver</codeEntityReference>
allows the creation of contracts to be customized.</para>
<para>Read more about Contract Resolvers here: <externalLink>
<linkText>Contract Resolvers</linkText>
<linkUri>ContractResolver.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para>
<para>Read more about Contract Resolvers here: <link xlink:href="ContractResolver" /></para>
</content>
</section>
@@ -343,11 +327,7 @@ or a property's object properties or collection items using
<content><para>The Json.NET serializer supports logging and debugging using the
<codeEntityReference>T:Newtonsoft.Json.Serialization.ITraceWriter</codeEntityReference> interface.
By assigning a trace writer you can debug what happens inside the Json.NET serializer when serializing and deserializing JSON.</para>
<para>Read more about TraceWriters here: <externalLink>
<linkText>Debugging with Serialization Tracing</linkText>
<linkUri>SerializationTracing.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para>
<para>Read more about TraceWriters here: <link xlink:href="SerializationTracing" /></para>
</content>
</section>
@@ -355,12 +335,7 @@ or a property's object properties or collection items using
<title>Error</title>
<content><para>The <codeEntityReference>E:Newtonsoft.Json.JsonSerializer.Error</codeEntityReference> 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.</para>
<para>Read more about error handling here: <externalLink>
<linkText>Serialization Error Handling</linkText>
<linkUri>SerializationErrorHandling.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink>
</para>
<para>Read more about error handling here: <link xlink:href="SerializationErrorHandling" /></para>
</content>
</section>
</sections>
Doc/SerializingJSON.aml
+1 -5
View File
@@ -42,11 +42,7 @@ LINQ to JSON objects or
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="JsonSerializerToStream" title="Serializing JSON to a Stream with JsonSerializer" />
<para>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.</para>
<para>Read more about the available JsonSerializer settings here: <externalLink>
<linkText>Serialization Settings</linkText>
<linkUri>SerializationSettings.htm</linkUri>
<linkTarget>_self</linkTarget>
</externalLink></para>
<para>Read more about the available JsonSerializer settings here: <link xlink:href="SerializationSettings" /></para>
</content>
</section>
<relatedTopics>
Doc/doc.shfbproj
+16 -12
View File
@@ -32,9 +32,9 @@
<BuildLogFile>
</BuildLogFile>
<HelpFileFormat>Website</HelpFileFormat>
<FrameworkVersion>.NET Framework 4.5.1</FrameworkVersion>
<HelpTitle>Json.NET - Documentation</HelpTitle>
<PresentationStyle>VS2005</PresentationStyle>
<FrameworkVersion>.NET Framework 4.5</FrameworkVersion>
<HelpTitle>Json.NET Documentation</HelpTitle>
<PresentationStyle>VS2013</PresentationStyle>
<NamingMethod>MemberName</NamingMethod>
<DocumentationSourcePath>..\Src\Newtonsoft.Json\bin\Release</DocumentationSourcePath>
<DocumentationSources>
@@ -57,12 +57,12 @@
<ComponentConfigurations>
<ComponentConfig id="Code Block Component" enabled="True">
<component id="Code Block Component" type="SandcastleBuilder.Components.CodeBlockComponent" assembly="{@SHFBFolder}SandcastleBuilder.Components.dll">
<basePath value="{@HtmlEncProjectFolder}" />
<outputPaths>{@HelpFormatOutputPaths}</outputPaths>
<allowMissingSource value="false" />
<removeRegionMarkers value="false" />
<colorizer syntaxFile="{@SHFBFolder}Colorizer\highlight.xml" styleFile="{@SHFBFolder}Colorizer\highlight.xsl" stylesheet="{@SHFBFolder}Colorizer\highlight.css" scriptFile="{@SHFBFolder}Colorizer\highlight.js" language="cs" tabSize="0" numberLines="true" outlining="false" keepSeeTags="false" defaultTitle="true" />
</component>
<basePath value="{@HtmlEncProjectFolder}" />
<outputPaths>{@HelpFormatOutputPaths}</outputPaths>
<allowMissingSource value="false" />
<removeRegionMarkers value="false" />
<colorizer syntaxFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xml" styleFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xsl" stylesheet="{@SHFBFolder}PresentationStyles\Colorizer\highlight.css" scriptFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.js" disabled="{@DisableCodeBlockComponent}" language="cs" tabSize="0" numberLines="true" outlining="false" keepSeeTags="false" defaultTitle="true" />
</component>
</ComponentConfig>
</ComponentConfigurations>
<IndentHtml>False</IndentHtml>
@@ -71,7 +71,7 @@
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
<CppCommentsFixup>False</CppCommentsFixup>
<CleanIntermediates>True</CleanIntermediates>
<SyntaxFilters>CSharp</SyntaxFilters>
<SyntaxFilters>C#</SyntaxFilters>
<SdkLinkTarget>Blank</SdkLinkTarget>
<Preliminary>False</Preliminary>
<Language>en-US</Language>
@@ -84,6 +84,8 @@
<Argument Key="logoPlacement" Value="left" />
<Argument Key="logoAlignment" Value="left" />
</TransformComponentArguments>
<MaximumGroupParts>2</MaximumGroupParts>
<NamespaceGrouping>False</NamespaceGrouping>
</PropertyGroup>
<!-- There are no properties for these two groups but they need to appear in
order for Visual Studio to perform the build. -->
@@ -95,6 +97,7 @@
<Content Include="donate.gif" />
</ItemGroup>
<ItemGroup>
<Content Include="icons\favicon.ico" />
<None Include="Samples\Json\CustomJsonWriter.aml" />
<None Include="Samples\Json\CustomJsonReader.aml" />
<None Include="Samples\Xml\ConvertXmlToJsonForceArray.aml" />
@@ -247,12 +250,13 @@
<ImageId>performance</ImageId>
<AlternateText>performance</AlternateText>
</Image>
<Image Include="logo.jpg">
<Content Include="icons\logo.jpg">
<ImageId>logo</ImageId>
<AlternateText>logo</AlternateText>
</Image>
</Content>
</ItemGroup>
<ItemGroup>
<Folder Include="icons\" />
<Folder Include="Samples\Xml\" />
<Folder Include="Samples\Schema\" />
<Folder Include="Samples\Linq\" />
Doc/icons/favicon.ico
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

Doc/logo.jpg → Doc/icons/logo.jpg
View File