Commit 323e6321 authored by kenton@google.com's avatar kenton@google.com

doc comment tweaks

parent 75fcd790
...@@ -40,8 +40,8 @@ import java.io.OutputStream; ...@@ -40,8 +40,8 @@ import java.io.OutputStream;
/** /**
* Abstract interface implemented by Protocol Message objects. * Abstract interface implemented by Protocol Message objects.
* *
* <p>This interface is implemented by all protocol message objects. Most * <p>This interface is implemented by all protocol message objects. Non-lite
* users will be more interested in the Message interface, which is a subclass * messages additionally implement the Message interface, which is a subclass
* of MessageLite. Use MessageLite instead when you only need the subset of * of MessageLite. Use MessageLite instead when you only need the subset of
* features which it supports -- namely, nothing that uses descriptors or * features which it supports -- namely, nothing that uses descriptors or
* reflection. You can instruct the protocol compiler to generate classes * reflection. You can instruct the protocol compiler to generate classes
......
...@@ -33,11 +33,9 @@ ...@@ -33,11 +33,9 @@
// Sanjay Ghemawat, Jeff Dean, and others. // Sanjay Ghemawat, Jeff Dean, and others.
// //
// This file contains common implementations of the interfaces defined in // This file contains common implementations of the interfaces defined in
// zero_copy_stream.h. These implementations cover I/O on raw arrays, // zero_copy_stream.h which are only included in the full (non-lite)
// strings, and file descriptors. Of course, many users will probably // protobuf library. These implementations include Unix file descriptors
// want to write their own implementations of these interfaces specific // and C++ iostreams. See also: zero_copy_stream_impl_lite.h
// to the particular I/O abstractions they prefer to use, but these
// should cover the most common cases.
#ifndef GOOGLE_PROTOBUF_IO_ZERO_COPY_STREAM_IMPL_H__ #ifndef GOOGLE_PROTOBUF_IO_ZERO_COPY_STREAM_IMPL_H__
#define GOOGLE_PROTOBUF_IO_ZERO_COPY_STREAM_IMPL_H__ #define GOOGLE_PROTOBUF_IO_ZERO_COPY_STREAM_IMPL_H__
......
...@@ -33,11 +33,13 @@ ...@@ -33,11 +33,13 @@
// Sanjay Ghemawat, Jeff Dean, and others. // Sanjay Ghemawat, Jeff Dean, and others.
// //
// This file contains common implementations of the interfaces defined in // This file contains common implementations of the interfaces defined in
// zero_copy_stream.h. These implementations cover I/O on raw arrays, // zero_copy_stream.h which are included in the "lite" protobuf library.
// strings, and file descriptors. Of course, many users will probably // These implementations cover I/O on raw arrays and strings, as well as
// want to write their own implementations of these interfaces specific // adaptors which make it easy to implement streams based on traditional
// to the particular I/O abstractions they prefer to use, but these // streams. Of course, many users will probably want to write their own
// should cover the most common cases. // implementations of these interfaces specific to the particular I/O
// abstractions they prefer to use, but these should cover the most common
// cases.
#ifndef GOOGLE_PROTOBUF_IO_ZERO_COPY_STREAM_IMPL_LITE_H__ #ifndef GOOGLE_PROTOBUF_IO_ZERO_COPY_STREAM_IMPL_LITE_H__
#define GOOGLE_PROTOBUF_IO_ZERO_COPY_STREAM_IMPL_LITE_H__ #define GOOGLE_PROTOBUF_IO_ZERO_COPY_STREAM_IMPL_LITE_H__
......
...@@ -32,9 +32,10 @@ ...@@ -32,9 +32,10 @@
// Based on original Protocol Buffers design by // Based on original Protocol Buffers design by
// Sanjay Ghemawat, Jeff Dean, and others. // Sanjay Ghemawat, Jeff Dean, and others.
// //
// This file contains the abstract interface for all protocol messages. // Defines Message, the abstract interface implemented by non-lite
// Although it's possible to implement this interface manually, most users // protocol message objects. Although it's possible to implement this
// will use the protocol compiler to generate implementations. // interface manually, most users will use the protocol compiler to
// generate implementations.
// //
// Example usage: // Example usage:
// //
...@@ -168,7 +169,8 @@ struct Metadata { ...@@ -168,7 +169,8 @@ struct Metadata {
}; };
// Returns the EnumDescriptor for enum type E, which must be a // Returns the EnumDescriptor for enum type E, which must be a
// proto-declared enum type. // proto-declared enum type. Code generated by the protocol compiler
// will include specializations of this template for each enum type declared.
template <typename E> template <typename E>
const EnumDescriptor* GetEnumDescriptor(); const EnumDescriptor* GetEnumDescriptor();
......
...@@ -33,6 +33,8 @@ ...@@ -33,6 +33,8 @@
// Based on original Protocol Buffers design by // Based on original Protocol Buffers design by
// Sanjay Ghemawat, Jeff Dean, and others. // Sanjay Ghemawat, Jeff Dean, and others.
// //
// Defines MessageLite, the abstract interface implemented by all (lite
// and non-lite) protocol message objects.
#ifndef GOOGLE_PROTOBUF_MESSAGE_LITE_H__ #ifndef GOOGLE_PROTOBUF_MESSAGE_LITE_H__
#define GOOGLE_PROTOBUF_MESSAGE_LITE_H__ #define GOOGLE_PROTOBUF_MESSAGE_LITE_H__
...@@ -45,15 +47,15 @@ namespace protobuf { ...@@ -45,15 +47,15 @@ namespace protobuf {
// Interface to light weight protocol messages. // Interface to light weight protocol messages.
// //
// This interface is implemented by all protocol message objects. Most // This interface is implemented by all protocol message objects. Non-lite
// users will be more interested in the Message interface, which is a // messages additionally implement the Message interface, which is a
// subclass of MessageLite. Use MessageLite instead when you only need // subclass of MessageLite. Use MessageLite instead when you only need
// the subset of features which it supports -- namely, nothing that uses // the subset of features which it supports -- namely, nothing that uses
// descriptors or reflection. You can instruct the protocol compiler // descriptors or reflection. You can instruct the protocol compiler
// to generate classes which implement only MessageLite, not the full // to generate classes which implement only MessageLite, not the full
// Message interface, by adding the following line to the .proto file: // Message interface, by adding the following line to the .proto file:
// //
// option optimize_for = LITE_RUNTIME; // option optimize_for = LITE_RUNTIME;
// //
// This is particularly useful on resource-constrained systems where // This is particularly useful on resource-constrained systems where
// the full protocol buffers runtime library is too big. // the full protocol buffers runtime library is too big.
......
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