Commit Graph
10 Commits
Author SHA1 Message Date
stakx 8639ac94ae Typos
Running a spell checker on the whole solution revealed a couple more
typos. This fixes all of those (although internal // line comments are
mostly left alone).

Additionally, convert a very few string.Format occurrences to the pre-
dominant .FormatWith pattern and fix some incorrect message strings.
2017-01-04 03:01:26 +01:00
stakx 7644768580 Make JsonValidatingReader close underlying reader
Add `Close` method override in `JsonValidatingReader` so that the
`CloseInput` property is observed properly. Also add a corresponding
unit test.
2016-12-26 12:21:45 +01:00
stakx 1eb391c147 Replace "stream" in reader/writer classes' comments
XML documentation comments for JsonReader, JsonWriter and derived
classes often mention "underlying streams". In most cases however,
these types don't operate directly on Streams, but through other types
such as TextReader and TextWriter.

This commit changes these comments to reflect more accurately what
kind of objects the various JSON reader / writer classes operate on.

Additionally the effect of JsonReader.CloseInput and JsonWriter.Close-
Output is made more explicit in the comments for the Close methods.
2016-12-24 02:26:16 +01:00
stakx e19ac3f28c Add & fix crefs in XML document comments
* Add references to types where they are missing.

 * Fix incorrect references to closed generic types.

 * Convert member ID strings to proper references where they can be
   converted without breaking the build. The remaining member ID
   strings usually mean that the comment would have to be rephrased
   for at least one build target / platform.

 * Drop namespaces from type names where they are unnecessary.

 * Fix the odd typo and add additional <c> markup in a few places.
2016-12-23 16:15:24 +01:00
stakx 937d5a53bb XML comments: consistent formatting of C# keywords 2016-12-19 09:29:22 +01:00
stakx 2e6d2ecd4c Fix typos, punctuation, etc. in XML doc comments
* Simple stuff: typos and missing punctuation and line breaks.

 * Sometimes, two method overloads have quite different documentation.
   Rephrase these to make them more similar.

 * Minor rephrasings like in a previous commit (e.g. "...how output
   should be formatted", "initializes a new instance of...").

 * Obvious incorrect type references in comments. These appear mostly
   in `Utilities/LinqBridge.cs` (nullable vs non-nullable).

 * Remove factually incorrect statement about exceptions thrown.

 * Remove comments for explicitly implemented interface methods.
2016-12-18 01:01:46 +01:00
stakx f27ad19eb0 Amend omission in previous commit 2016-12-11 01:26:14 +01:00
stakx 01f370d1ff Change comments as per @JamesNK's feedback
* Explicitly implemented interfaces don't need comments.

 * Protected constructors of abstract classes should be documented
   like Microsoft does on MSDN.

 * Replace term "Common Language Runtime (CLR) type" with ".NET type".
2016-12-11 01:19:50 +01:00
stakx 3c6b49a3dd Revert crefs that cannot be resolved in all targets 2016-12-11 00:14:03 +01:00
stakx 067768a658 Fix minor issues in XML documentation comments
This fixes several minor issues in the code's documentation comments,
such as spelling errors, missing punctuation and references to other
code elements, and a few other small inconsistencies.
2016-12-10 22:53:40 +01:00