Add and fix C++ runtime docs
This commit is contained in:
parent
e8ae137c96
commit
3916a0aa99
@ -546,6 +546,7 @@ EXTRA_DIST = \
|
||||
google/protobuf/testdata/text_format_unittest_extensions_data_pointy.txt \
|
||||
google/protobuf/package_info.h \
|
||||
google/protobuf/io/package_info.h \
|
||||
google/protobuf/util/package_info.h \
|
||||
google/protobuf/compiler/ruby/ruby_generated_code.proto \
|
||||
google/protobuf/compiler/ruby/ruby_generated_code_pb.rb \
|
||||
google/protobuf/compiler/package_info.h \
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// This file defines an Arena allocator for better allocation performance.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_ARENA_H__
|
||||
#define GOOGLE_PROTOBUF_ARENA_H__
|
||||
|
||||
@ -211,12 +213,10 @@ struct ArenaOptions {
|
||||
//
|
||||
// This protocol is implemented by all arena-enabled proto2 message classes as
|
||||
// well as RepeatedPtrField.
|
||||
|
||||
#if __cplusplus >= 201103L
|
||||
class LIBPROTOBUF_EXPORT Arena final {
|
||||
#else
|
||||
//
|
||||
// Do NOT subclass Arena. This class will be marked as final when C++11 is
|
||||
// enabled.
|
||||
class LIBPROTOBUF_EXPORT Arena {
|
||||
#endif
|
||||
public:
|
||||
// Arena constructor taking custom options. See ArenaOptions below for
|
||||
// descriptions of the options available.
|
||||
|
@ -55,6 +55,11 @@ class FileDescriptor; // descriptor.h
|
||||
class FileDescriptorProto; // descriptor.pb.h
|
||||
template<typename T> class RepeatedPtrField; // repeated_field.h
|
||||
|
||||
} // namespace protobuf
|
||||
} // namespace google
|
||||
|
||||
namespace google {
|
||||
namespace protobuf {
|
||||
namespace compiler {
|
||||
|
||||
class CodeGenerator; // code_generator.h
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Generates C# code for a given .proto file.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_COMPILER_CSHARP_GENERATOR_H__
|
||||
#define GOOGLE_PROTOBUF_COMPILER_CSHARP_GENERATOR_H__
|
||||
|
||||
@ -40,6 +42,10 @@ namespace protobuf {
|
||||
namespace compiler {
|
||||
namespace csharp {
|
||||
|
||||
// CodeGenerator implementation which generates a C# source file and
|
||||
// header. If you create your own protocol compiler binary and you want
|
||||
// it to support C# output, you can do so by registering an instance of this
|
||||
// CodeGenerator with the CommandLineInterface in your main() function.
|
||||
class LIBPROTOC_EXPORT Generator
|
||||
: public google::protobuf::compiler::CodeGenerator {
|
||||
virtual bool Generate(
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Generates JavaScript code for a given .proto file.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_COMPILER_JS_GENERATOR_H__
|
||||
#define GOOGLE_PROTOBUF_COMPILER_JS_GENERATOR_H__
|
||||
|
||||
@ -90,6 +92,10 @@ struct GeneratorOptions {
|
||||
string* error);
|
||||
};
|
||||
|
||||
// CodeGenerator implementation which generates a JavaScript source file and
|
||||
// header. If you create your own protocol compiler binary and you want it to
|
||||
// support JavaScript output, you can do so by registering an instance of this
|
||||
// CodeGenerator with the CommandLineInterface in your main() function.
|
||||
class LIBPROTOC_EXPORT Generator : public CodeGenerator {
|
||||
public:
|
||||
Generator() {}
|
||||
|
@ -41,6 +41,10 @@ namespace protobuf {
|
||||
namespace compiler {
|
||||
namespace objectivec {
|
||||
|
||||
// CodeGenerator implementation which generates a ObjectiveC source file and
|
||||
// header. If you create your own protocol compiler binary and you want it to
|
||||
// support ObjectiveC output, you can do so by registering an instance of this
|
||||
// CodeGenerator with the CommandLineInterface in your main() function.
|
||||
class LIBPROTOC_EXPORT ObjectiveCGenerator : public CodeGenerator {
|
||||
public:
|
||||
ObjectiveCGenerator();
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Helper functions for generating ObjectiveC code.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_COMPILER_OBJECTIVEC_HELPERS_H__
|
||||
#define GOOGLE_PROTOBUF_COMPILER_OBJECTIVEC_HELPERS_H__
|
||||
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Generates Ruby code for a given .proto file.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_COMPILER_RUBY_GENERATOR_H__
|
||||
#define GOOGLE_PROTOBUF_COMPILER_RUBY_GENERATOR_H__
|
||||
|
||||
@ -40,6 +42,10 @@ namespace protobuf {
|
||||
namespace compiler {
|
||||
namespace ruby {
|
||||
|
||||
// CodeGenerator implementation for generated Ruby protocol buffer classes.
|
||||
// If you create your own protocol compiler binary and you want it to support
|
||||
// Ruby output, you can do so by registering an instance of this
|
||||
// CodeGenerator with the CommandLineInterface in your main() function.
|
||||
class LIBPROTOC_EXPORT Generator
|
||||
: public google::protobuf::compiler::CodeGenerator {
|
||||
virtual bool Generate(
|
||||
|
@ -28,6 +28,12 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// This file defines the map container and its helpers to support protobuf maps.
|
||||
//
|
||||
// The Map and MapIterator types are provided by this header file.
|
||||
// Please avoid using other types defined here, unless they are public
|
||||
// types within Map or MapIterator, such as Map::value_type.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_MAP_H__
|
||||
#define GOOGLE_PROTOBUF_MAP_H__
|
||||
|
||||
@ -50,9 +56,6 @@
|
||||
namespace google {
|
||||
namespace protobuf {
|
||||
|
||||
// The Map and MapIterator types are provided by this header file.
|
||||
// Please avoid using other types defined here, unless they are public
|
||||
// types within Map or MapIterator, such as Map::value_type.
|
||||
template <typename Key, typename T>
|
||||
class Map;
|
||||
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Defines classes for field comparison.
|
||||
|
||||
// Author: ksroka@google.com (Krzysztof Sroka)
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_UTIL_FIELD_COMPARATOR_H__
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Defines utilities for the FieldMask well known type.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_UTIL_FIELD_MASK_UTIL_H__
|
||||
#define GOOGLE_PROTOBUF_UTIL_FIELD_MASK_UTIL_H__
|
||||
|
||||
|
46
src/google/protobuf/util/package_info.h
Normal file
46
src/google/protobuf/util/package_info.h
Normal file
@ -0,0 +1,46 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// This file exists solely to document the google::protobuf::util namespace.
|
||||
// It is not compiled into anything, but it may be read by an automated
|
||||
// documentation generator.
|
||||
|
||||
namespace google {
|
||||
|
||||
namespace protobuf {
|
||||
|
||||
// Utility classes.
|
||||
//
|
||||
// This package contains various utilities for message comprasion, JSON
|
||||
// conversion, well known types, etc.
|
||||
namespace util {}
|
||||
|
||||
} // namespace protobuf
|
||||
} // namespace google
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Defines utilities for the Timestamp and Duration well known types.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_UTIL_TIME_UTIL_H__
|
||||
#define GOOGLE_PROTOBUF_UTIL_TIME_UTIL_H__
|
||||
|
||||
@ -47,6 +49,7 @@ namespace google {
|
||||
namespace protobuf {
|
||||
namespace util {
|
||||
|
||||
// Utility functions for Timestamp and Duration.
|
||||
class LIBPROTOBUF_EXPORT TimeUtil {
|
||||
typedef google::protobuf::Timestamp Timestamp;
|
||||
typedef google::protobuf::Duration Duration;
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Defines a TypeResolver for the Any message.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_UTIL_TYPE_RESOLVER_H__
|
||||
#define GOOGLE_PROTOBUF_UTIL_TYPE_RESOLVER_H__
|
||||
|
||||
|
@ -28,6 +28,8 @@
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Defines utilities for the TypeResolver.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_UTIL_TYPE_RESOLVER_UTIL_H__
|
||||
#define GOOGLE_PROTOBUF_UTIL_TYPE_RESOLVER_UTIL_H__
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user