Commit f67c8336 authored by csharptest's avatar csharptest Committed by rogerk

Added comments for private fields

Renamed StartMessage(name) to WriteMessageStart(name) on XmlFormatWriter as this
was intended to be an overload that did not get renamed.
parent fa8fa924
...@@ -11,6 +11,7 @@ namespace Google.ProtocolBuffers.Serialization ...@@ -11,6 +11,7 @@ namespace Google.ProtocolBuffers.Serialization
public class JsonFormatReader : AbstractTextReader public class JsonFormatReader : AbstractTextReader
{ {
private readonly JsonCursor _input; private readonly JsonCursor _input;
// The expected token that ends the current item, either ']' or '}'
private readonly Stack<int> _stopChar; private readonly Stack<int> _stopChar;
private enum ReaderState private enum ReaderState
......
...@@ -168,7 +168,9 @@ namespace Google.ProtocolBuffers.Serialization ...@@ -168,7 +168,9 @@ namespace Google.ProtocolBuffers.Serialization
#endregion #endregion
//Tracks the writer depth and the array element count at that depth.
private readonly List<int> _counter; private readonly List<int> _counter;
//True if the top-level of the writer is an array as opposed to a single message.
private bool _isArray; private bool _isArray;
/// <summary> /// <summary>
......
...@@ -2,6 +2,7 @@ using System; ...@@ -2,6 +2,7 @@ using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using System.Xml; using System.Xml;
using System.Diagnostics;
namespace Google.ProtocolBuffers.Serialization namespace Google.ProtocolBuffers.Serialization
{ {
...@@ -14,7 +15,9 @@ namespace Google.ProtocolBuffers.Serialization ...@@ -14,7 +15,9 @@ namespace Google.ProtocolBuffers.Serialization
{ {
public const string DefaultRootElementName = XmlFormatWriter.DefaultRootElementName; public const string DefaultRootElementName = XmlFormatWriter.DefaultRootElementName;
private readonly XmlReader _input; private readonly XmlReader _input;
// Tracks the message element for each nested message read
private readonly Stack<ElementStackEntry> _elements; private readonly Stack<ElementStackEntry> _elements;
// The default element name for ReadMessageStart
private string _rootElementName; private string _rootElementName;
private struct ElementStackEntry private struct ElementStackEntry
...@@ -118,6 +121,7 @@ namespace Google.ProtocolBuffers.Serialization ...@@ -118,6 +121,7 @@ namespace Google.ProtocolBuffers.Serialization
} }
} }
[DebuggerNonUserCode]
private static void Assert(bool cond) private static void Assert(bool cond)
{ {
if (!cond) if (!cond)
......
...@@ -16,9 +16,11 @@ namespace Google.ProtocolBuffers.Serialization ...@@ -16,9 +16,11 @@ namespace Google.ProtocolBuffers.Serialization
{ {
private static readonly Encoding DefaultEncoding = new UTF8Encoding(false); private static readonly Encoding DefaultEncoding = new UTF8Encoding(false);
public const string DefaultRootElementName = "root"; public const string DefaultRootElementName = "root";
private const int NestedArrayFlag = 0x0001;
private readonly XmlWriter _output; private readonly XmlWriter _output;
// The default element name used for WriteMessageStart
private string _rootElementName; private string _rootElementName;
// Used to assert matching WriteMessageStart/WriteMessageEnd calls
private int _messageOpenCount; private int _messageOpenCount;
private static XmlWriterSettings DefaultSettings(Encoding encoding) private static XmlWriterSettings DefaultSettings(Encoding encoding)
...@@ -119,7 +121,7 @@ namespace Google.ProtocolBuffers.Serialization ...@@ -119,7 +121,7 @@ namespace Google.ProtocolBuffers.Serialization
/// </summary> /// </summary>
public override void WriteMessageStart() public override void WriteMessageStart()
{ {
StartMessage(_rootElementName); WriteMessageStart(_rootElementName);
} }
/// <summary> /// <summary>
...@@ -127,7 +129,7 @@ namespace Google.ProtocolBuffers.Serialization ...@@ -127,7 +129,7 @@ namespace Google.ProtocolBuffers.Serialization
/// After this call you can call IMessageLite.MergeTo(...) and complete the message with /// After this call you can call IMessageLite.MergeTo(...) and complete the message with
/// a call to WriteMessageEnd(). /// a call to WriteMessageEnd().
/// </summary> /// </summary>
public void StartMessage(string elementName) public void WriteMessageStart(string elementName)
{ {
if (TestOption(XmlWriterOptions.OutputJsonTypes)) if (TestOption(XmlWriterOptions.OutputJsonTypes))
{ {
...@@ -169,7 +171,7 @@ namespace Google.ProtocolBuffers.Serialization ...@@ -169,7 +171,7 @@ namespace Google.ProtocolBuffers.Serialization
/// </summary> /// </summary>
public void WriteMessage(string elementName, IMessageLite message) public void WriteMessage(string elementName, IMessageLite message)
{ {
StartMessage(elementName); WriteMessageStart(elementName);
message.WriteTo(this); message.WriteTo(this);
WriteMessageEnd(); WriteMessageEnd();
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment