diff options
author | Thomas Van Lenten <thomasvl@google.com> | 2017-06-19 10:21:33 -0400 |
---|---|---|
committer | Thomas Van Lenten <thomasvl@google.com> | 2017-06-19 10:33:45 -0400 |
commit | 5fd71ce6312e6d7620f1f443d4181629695733a4 (patch) | |
tree | 8efd87a31e9e2e6f722365cd3a35b19c9162e578 /objectivec/GPBCodedOutputStream.h | |
parent | 72e293a28f4be911b9dd7c79836e32a9b2b6e09d (diff) | |
download | protobuf-5fd71ce6312e6d7620f1f443d4181629695733a4.tar.gz protobuf-5fd71ce6312e6d7620f1f443d4181629695733a4.tar.bz2 protobuf-5fd71ce6312e6d7620f1f443d4181629695733a4.zip |
ObjC: Document the exceptions on some of the writing apis.
Diffstat (limited to 'objectivec/GPBCodedOutputStream.h')
-rw-r--r-- | objectivec/GPBCodedOutputStream.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/objectivec/GPBCodedOutputStream.h b/objectivec/GPBCodedOutputStream.h index d6fff3db..23c404b8 100644 --- a/objectivec/GPBCodedOutputStream.h +++ b/objectivec/GPBCodedOutputStream.h @@ -47,11 +47,20 @@ NS_ASSUME_NONNULL_BEGIN /** + * @c GPBCodedOutputStream exception names. + **/ +extern NSString *const GPBCodedOutputStreamException_OutOfSpace; +extern NSString *const GPBCodedOutputStreamException_WriteFailed; + +/** * Writes out protocol message fields. * * The common uses of protocol buffers shouldn't need to use this class. * GPBMessage's provide a -data method that will serialize the message for you. * + * @note Any -write* api can raise the GPBCodedOutputStreamException_* + * exceptions. + * * @note Subclassing of GPBCodedOutputStream is NOT supported. **/ @interface GPBCodedOutputStream : NSObject |