java_doc_comment.h 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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. // Author: kenton@google.com (Kenton Varda)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_DOC_COMMENT_H__
  34. #define GOOGLE_PROTOBUF_COMPILER_JAVA_DOC_COMMENT_H__
  35. #include <google/protobuf/descriptor.h>
  36. namespace google {
  37. namespace protobuf {
  38. namespace io {
  39. class Printer; // printer.h
  40. }
  41. }
  42. namespace protobuf {
  43. namespace compiler {
  44. namespace java {
  45. void WriteMessageDocComment(io::Printer* printer, const Descriptor* message);
  46. void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field);
  47. void WriteEnumDocComment(io::Printer* printer, const EnumDescriptor* enum_);
  48. void WriteEnumValueDocComment(io::Printer* printer,
  49. const EnumValueDescriptor* value);
  50. void WriteServiceDocComment(io::Printer* printer,
  51. const ServiceDescriptor* service);
  52. void WriteMethodDocComment(io::Printer* printer,
  53. const MethodDescriptor* method);
  54. // Exposed for testing only.
  55. LIBPROTOC_EXPORT string EscapeJavadoc(const string& input);
  56. } // namespace java
  57. } // namespace compiler
  58. } // namespace protobuf
  59. } // namespace google
  60. #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_DOC_COMMENT_H__