Add documentation and split JSON Path into its own documentation section (#1925)
This commit is contained in:
James Newton-King
@@ -0,0 +1,14 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<topic id="ErrorWhenNoMatchQuery" revisionNumber="1">
|
||||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<introduction>
|
||||
<para>This sample loads JSON and then queries values from it using <codeEntityReference>Overload:Newtonsoft.Json.Linq.JToken.SelectToken</codeEntityReference>. An error is thrown when part of the JSON path is not found.</para>
|
||||
</introduction>
|
||||
<section>
|
||||
<title>Sample</title>
|
||||
<content>
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\JsonPath\ErrorWhenNoMatchQuery.cs" region="Usage" title="Usage" />
|
||||
</content>
|
||||
</section>
|
||||
</developerConceptualDocument>
|
||||
</topic>
|
||||
+1
-1
@@ -7,7 +7,7 @@
|
||||
<section>
|
||||
<title>Sample</title>
|
||||
<content>
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\Linq\QueryJsonSelectToken.cs" region="Usage" title="Usage" />
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\JsonPath\QueryJsonSelectToken.cs" region="Usage" title="Usage" />
|
||||
</content>
|
||||
</section>
|
||||
</developerConceptualDocument>
|
||||
+1
-1
@@ -7,7 +7,7 @@
|
||||
<section>
|
||||
<title>Sample</title>
|
||||
<content>
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\Linq\QueryJsonSelectTokenEscaped.cs" region="Usage" title="Usage" />
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\JsonPath\QueryJsonSelectTokenEscaped.cs" region="Usage" title="Usage" />
|
||||
</content>
|
||||
</section>
|
||||
</developerConceptualDocument>
|
||||
+1
-1
@@ -11,7 +11,7 @@
|
||||
<section>
|
||||
<title>Sample</title>
|
||||
<content>
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\Linq\QueryJsonSelectTokenJsonPath.cs" region="Usage" title="Usage" />
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\JsonPath\QueryJsonSelectTokenJsonPath.cs" region="Usage" title="Usage" />
|
||||
</content>
|
||||
</section>
|
||||
</developerConceptualDocument>
|
||||
+1
-1
@@ -8,7 +8,7 @@
|
||||
<section>
|
||||
<title>Sample</title>
|
||||
<content>
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\Linq\QueryJsonSelectTokenWithLinq.cs" region="Usage" title="Usage" />
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\JsonPath\QueryJsonSelectTokenWithLinq.cs" region="Usage" title="Usage" />
|
||||
</content>
|
||||
</section>
|
||||
</developerConceptualDocument>
|
||||
@@ -0,0 +1,14 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<topic id="RegexQuery" revisionNumber="1">
|
||||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<introduction>
|
||||
<para>This sample loads JSON and then queries values from it using <codeEntityReference>M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)</codeEntityReference> with a regex JSON Path.</para>
|
||||
</introduction>
|
||||
<section>
|
||||
<title>Sample</title>
|
||||
<content>
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\JsonPath\RegexQuery.cs" region="Usage" title="Usage" />
|
||||
</content>
|
||||
</section>
|
||||
</developerConceptualDocument>
|
||||
</topic>
|
||||
@@ -0,0 +1,14 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<topic id="StrictEqualsQuery" revisionNumber="1">
|
||||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<introduction>
|
||||
<para>This sample loads JSON and then queries values from it using <codeEntityReference>M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)</codeEntityReference> with a strict equals JSON Path.</para>
|
||||
</introduction>
|
||||
<section>
|
||||
<title>Sample</title>
|
||||
<content>
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\JsonPath\StrictEqualsQuery.cs" region="Usage" title="Usage" />
|
||||
</content>
|
||||
</section>
|
||||
</developerConceptualDocument>
|
||||
</topic>
|
||||
@@ -2,8 +2,8 @@
|
||||
<topic id="CustomJsonConverterGeneric" revisionNumber="1">
|
||||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<introduction>
|
||||
<para>This sample creates a custom <codeEntityReference>T:Newtonsoft.Json.JsonConverter{T}</codeEntityReference>
|
||||
that overrides serialization for the Version property with a custom display string.</para>
|
||||
<para>This sample creates a custom converter from <c>JsonConverter<T></c>
|
||||
that overrides serialization for the <c>Version</c> class with a custom display string.</para>
|
||||
</introduction>
|
||||
<section>
|
||||
<title>Sample</title>
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
<linkTarget>_blank</linkTarget>
|
||||
</externalLink>.</para>
|
||||
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\Linq\QueryJsonSelectTokenJsonPath.cs" region="Usage" title="SelectToken With JSONPath" />
|
||||
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\Samples\JsonPath\QueryJsonSelectTokenJsonPath.cs" region="Usage" title="SelectToken With JSONPath" />
|
||||
</content>
|
||||
</section>
|
||||
<section address="SelectTokenLINQ">
|
||||
|
||||
+12
-7
@@ -29,7 +29,7 @@
|
||||
<Topic id="ConvertingJSONandXML" visible="True" title="Converting between JSON and XML" />
|
||||
<Topic id="JsonNetVsDotNetSerializers" visible="True" title="Json.NET vs .NET Serializers" />
|
||||
<Topic id="Samples" visible="True" isExpanded="true" title="Samples">
|
||||
<Topic id="d6e185d5-c992-44fc-8d8f-d9acc2bbec2f" visible="True" noFile="true" isExpanded="true" title="Serializing JSON">
|
||||
<Topic id="d6e185d5-c992-44fc-8d8f-d9acc2bbec2f" visible="True" noFile="true" title="Serializing JSON">
|
||||
<Topic id="SerializeObject" visible="True" title="Serialize an Object" />
|
||||
<Topic id="SerializeCollection" visible="True" title="Serialize a Collection" />
|
||||
<Topic id="SerializeDictionary" visible="True" title="Serialize a Dictionary" />
|
||||
@@ -63,7 +63,7 @@
|
||||
<Topic id="ErrorHandlingEvent" visible="True" title="ErrorHandling setting" />
|
||||
<Topic id="MaxDepth" visible="True" title="MaxDepth setting" />
|
||||
<Topic id="CustomJsonConverter" visible="True" title="Custom JsonConverter" />
|
||||
<Topic id="CustomJsonConverterGeneric" visible="True" isSelected="true" title="Custom JsonConverter<T>" />
|
||||
<Topic id="CustomJsonConverterGeneric" visible="True" title="Custom JsonConverter<T>" />
|
||||
<Topic id="CustomContractResolver" visible="True" title="Custom IContractResolver" />
|
||||
<Topic id="CustomTraceWriter" visible="True" title="Custom ITraceWriter" />
|
||||
<Topic id="SerializeSerializationBinder" visible="True" title="Custom SerializationBinder" />
|
||||
@@ -96,7 +96,7 @@
|
||||
<Topic id="NamingStrategySkipDictionaryKeys" visible="True" title="Configure NamingStrategy dictionary serialization" />
|
||||
<Topic id="NamingStrategySkipSpecifiedNames" visible="True" title="Configure NamingStrategy property name serialization" />
|
||||
</Topic>
|
||||
<Topic id="68b9fad2-5436-4e35-a734-9b9d751cc3e5" visible="True" noFile="true" title="LINQ to JSON">
|
||||
<Topic id="68b9fad2-5436-4e35-a734-9b9d751cc3e5" visible="True" noFile="true" isExpanded="true" title="LINQ to JSON">
|
||||
<Topic id="CreateJsonManually" visible="True" title="Create JSON manually" />
|
||||
<Topic id="CreateJsonCollectionInitializer" visible="True" title="Create JSON using Collection Initializers" />
|
||||
<Topic id="CreateJsonDeclaratively" visible="True" title="Create JSON declaratively with LINQ" />
|
||||
@@ -114,10 +114,6 @@
|
||||
<Topic id="QueryJson" visible="True" title="Querying JSON" />
|
||||
<Topic id="QueryJsonDynamic" visible="True" title="Querying JSON with dynamic" />
|
||||
<Topic id="QueryJsonLinq" visible="True" title="Querying JSON with LINQ" />
|
||||
<Topic id="QueryJsonSelectToken" visible="True" title="Querying JSON with SelectToken" />
|
||||
<Topic id="QueryJsonSelectTokenEscaped" visible="True" title="Querying JSON with SelectToken and escaped properties" />
|
||||
<Topic id="QueryJsonSelectTokenWithLinq" visible="True" title="Querying JSON with SelectToken and LINQ" />
|
||||
<Topic id="QueryJsonSelectTokenJsonPath" visible="True" title="Querying JSON with JSONPath" />
|
||||
<Topic id="ReadJson" visible="True" title="Read JSON from a file" />
|
||||
<Topic id="WriteToJsonFile" visible="True" title="Write JSON to a file" />
|
||||
<Topic id="ToObjectComplex" visible="True" title="Convert JSON to Collection" />
|
||||
@@ -136,6 +132,15 @@
|
||||
<Topic id="ReadJTokenFromBson" visible="True" title="Read from BSON" />
|
||||
<Topic id="WriteJTokenToBson" visible="True" title="Write as BSON" />
|
||||
</Topic>
|
||||
<Topic id="afd615f0-b6b4-40ec-997d-2453e60a25af" visible="True" noFile="true" isExpanded="true" title="JSON Path">
|
||||
<Topic id="QueryJsonSelectToken" visible="True" title="Querying JSON with JSON Path" />
|
||||
<Topic id="QueryJsonSelectTokenEscaped" visible="True" title="Querying JSON with JSON Path and escaped properties" />
|
||||
<Topic id="QueryJsonSelectTokenJsonPath" visible="True" title="Querying JSON with complex JSON Path" />
|
||||
<Topic id="QueryJsonSelectTokenWithLinq" visible="True" title="Querying JSON with JSON Path and LINQ" />
|
||||
<Topic id="RegexQuery" visible="True" title="JSON Path regex operator" />
|
||||
<Topic id="StrictEqualsQuery" visible="True" title="JSON Path strict equals operator" />
|
||||
<Topic id="ErrorWhenNoMatchQuery" visible="True" isSelected="true" title="Throw error when JSON Path not found" />
|
||||
</Topic>
|
||||
<Topic id="11cded7e-959a-4c6d-a9c9-61d571b75edc" visible="True" noFile="true" title="JSON Schema">
|
||||
<Topic id="JsonSchemaParse" visible="True" title="Parse JSON Schema from JSON" />
|
||||
<Topic id="LoadJsonSchemaFromFile" visible="True" title="Load JSON Schema from a file" />
|
||||
|
||||
+10
-6
@@ -8,7 +8,7 @@
|
||||
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
|
||||
<SchemaVersion>2.0</SchemaVersion>
|
||||
<ProjectGuid>{fd19f68e-72c8-4576-9775-b4480b0db686}</ProjectGuid>
|
||||
<SHFBSchemaVersion>2015.6.5.0</SHFBSchemaVersion>
|
||||
<SHFBSchemaVersion>2017.9.26.0</SHFBSchemaVersion>
|
||||
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
|
||||
Studio adds them anyway -->
|
||||
<AssemblyName>Documentation</AssemblyName>
|
||||
@@ -20,7 +20,7 @@
|
||||
<ProjectSummary>
|
||||
</ProjectSummary>
|
||||
<MissingTags>Summary, Parameter, Returns, AutoDocumentCtors, Namespace, TypeParameter, AutoDocumentDispose</MissingTags>
|
||||
<VisibleItems>InheritedMembers, InheritedFrameworkMembers, Protected, SealedProtected, ProtectedInternalAsProtected</VisibleItems>
|
||||
<VisibleItems>InheritedMembers, InheritedFrameworkMembers, Protected, SealedProtected, ProtectedInternalAsProtected, EditorBrowsableNever, NonBrowsable</VisibleItems>
|
||||
<HtmlHelp1xCompilerPath>
|
||||
</HtmlHelp1xCompilerPath>
|
||||
<HtmlHelp2xCompilerPath>
|
||||
@@ -97,13 +97,19 @@
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<Content Include="icons\favicon.ico" />
|
||||
<None Include="Samples\JsonPath\StrictEqualsQuery.aml" />
|
||||
<None Include="Samples\JsonPath\RegexQuery.aml" />
|
||||
<None Include="Samples\JsonPath\QueryJsonSelectTokenWithLinq.aml" />
|
||||
<None Include="Samples\JsonPath\QueryJsonSelectTokenJsonPath.aml" />
|
||||
<None Include="Samples\JsonPath\QueryJsonSelectTokenEscaped.aml" />
|
||||
<None Include="Samples\JsonPath\QueryJsonSelectToken.aml" />
|
||||
<None Include="Samples\JsonPath\ErrorWhenNoMatchQuery.aml" />
|
||||
<None Include="Samples\Serializer\CustomJsonConverterGeneric.aml" />
|
||||
<None Include="Samples\Serializer\NamingStrategyAttributes.aml" />
|
||||
<None Include="Samples\Serializer\NamingStrategySnakeCase.aml" />
|
||||
<None Include="Samples\Serializer\NamingStrategySkipSpecifiedNames.aml" />
|
||||
<None Include="Samples\Serializer\NamingStrategySkipDictionaryKeys.aml" />
|
||||
<None Include="Samples\Serializer\NamingStrategyCamelCase.aml" />
|
||||
<None Include="Samples\Linq\QueryJsonSelectTokenEscaped.aml" />
|
||||
<None Include="Samples\Serializer\JsonConstructorAttribute.aml" />
|
||||
<None Include="Samples\Json\ReadMultipleContentWithJsonReader.aml" />
|
||||
<None Include="Samples\Serializer\SerializeImmutableCollections.aml" />
|
||||
@@ -115,7 +121,6 @@
|
||||
<None Include="Samples\Serializer\DeserializeExtensionData.aml" />
|
||||
<None Include="Samples\Serializer\DeserializeDateFormatString.aml" />
|
||||
<None Include="Samples\Serializer\DefaultSettings.aml" />
|
||||
<None Include="Samples\Linq\QueryJsonSelectTokenJsonPath.aml" />
|
||||
<None Include="Samples\Linq\MergeJson.aml" />
|
||||
<None Include="Samples\Linq\JTokenAnnotation.aml" />
|
||||
<None Include="Samples\Json\CustomJsonWriter.aml" />
|
||||
@@ -142,8 +147,6 @@
|
||||
<None Include="Samples\Linq\SerializeWithLinq.aml" />
|
||||
<None Include="Samples\Linq\ReadJTokenFromBson.aml" />
|
||||
<None Include="Samples\Linq\ReadJson.aml" />
|
||||
<None Include="Samples\Linq\QueryJsonSelectTokenWithLinq.aml" />
|
||||
<None Include="Samples\Linq\QueryJsonSelectToken.aml" />
|
||||
<None Include="Samples\Linq\QueryJsonLinq.aml" />
|
||||
<None Include="Samples\Linq\QueryJsonDynamic.aml" />
|
||||
<None Include="Samples\Linq\QueryJson.aml" />
|
||||
@@ -272,6 +275,7 @@
|
||||
</Content>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<Folder Include="Samples\JsonPath\" />
|
||||
<Folder Include="icons\" />
|
||||
<Folder Include="Samples\Xml\" />
|
||||
<Folder Include="Samples\Schema\" />
|
||||
|
||||
Reference in New Issue
Block a user