1 // Protocol Buffers - Google's data interchange format 2 // Copyright 2008 Google Inc. All rights reserved. 3 // https://developers.google.com/protocol-buffers/ 4 // 5 // Redistribution and use in source and binary forms, with or without 6 // modification, are permitted provided that the following conditions are 7 // met: 8 // 9 // * Redistributions of source code must retain the above copyright 10 // notice, this list of conditions and the following disclaimer. 11 // * Redistributions in binary form must reproduce the above 12 // copyright notice, this list of conditions and the following disclaimer 13 // in the documentation and/or other materials provided with the 14 // distribution. 15 // * Neither the name of Google Inc. nor the names of its 16 // contributors may be used to endorse or promote products derived from 17 // this software without specific prior written permission. 18 // 19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31 // Author: kenton@google.com (Kenton Varda) 32 // Based on original Protocol Buffers design by 33 // Sanjay Ghemawat, Jeff Dean, and others. 34 35 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_DOC_COMMENT_H__ 36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_DOC_COMMENT_H__ 37 38 #include <google/protobuf/descriptor.h> 39 40 #include <google/protobuf/port_def.inc> 41 42 namespace google { 43 namespace protobuf { 44 namespace io { 45 class Printer; // printer.h 46 } 47 } // namespace protobuf 48 } // namespace google 49 50 namespace google { 51 namespace protobuf { 52 namespace compiler { 53 namespace java { 54 55 void WriteMessageDocComment(io::Printer* printer, const Descriptor* message); 56 void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field); 57 void WriteEnumDocComment(io::Printer* printer, const EnumDescriptor* enum_); 58 void WriteEnumValueDocComment(io::Printer* printer, 59 const EnumValueDescriptor* value); 60 void WriteServiceDocComment(io::Printer* printer, 61 const ServiceDescriptor* service); 62 void WriteMethodDocComment(io::Printer* printer, 63 const MethodDescriptor* method); 64 65 // Exposed for testing only. 66 PROTOC_EXPORT std::string EscapeJavadoc(const std::string& input); 67 68 } // namespace java 69 } // namespace compiler 70 } // namespace protobuf 71 } // namespace google 72 73 #include <google/protobuf/port_undef.inc> 74 75 #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_DOC_COMMENT_H__ 76