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// Must be included last.
41#include <google/protobuf/port_def.inc>
42
43namespace google {
44namespace protobuf {
45namespace io {
46class Printer; // printer.h
47}
48} // namespace protobuf
49} // namespace google
50
51namespace google {
52namespace protobuf {
53namespace compiler {
54namespace java {
55
56enum FieldAccessorType {
57 HAZZER,
58 GETTER,
59 SETTER,
60 CLEARER,
61 // Repeated
62 LIST_COUNT,
63 LIST_GETTER,
64 LIST_INDEXED_GETTER,
65 LIST_INDEXED_SETTER,
66 LIST_ADDER,
67 LIST_MULTI_ADDER
68};
69
70void WriteMessageDocComment(io::Printer* printer, const Descriptor* message);
71void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field);
72void WriteFieldAccessorDocComment(io::Printer* printer,
73 const FieldDescriptor* field,
74 const FieldAccessorType type,
75 const bool builder = false);
76void WriteFieldEnumValueAccessorDocComment(io::Printer* printer,
77 const FieldDescriptor* field,
78 const FieldAccessorType type,
79 const bool builder = false);
80void WriteFieldStringBytesAccessorDocComment(io::Printer* printer,
81 const FieldDescriptor* field,
82 const FieldAccessorType type,
83 const bool builder = false);
84void WriteEnumDocComment(io::Printer* printer, const EnumDescriptor* enum_);
85void WriteEnumValueDocComment(io::Printer* printer,
86 const EnumValueDescriptor* value);
87void WriteServiceDocComment(io::Printer* printer,
88 const ServiceDescriptor* service);
89void WriteMethodDocComment(io::Printer* printer,
90 const MethodDescriptor* method);
91
92// Exposed for testing only.
93PROTOC_EXPORT std::string EscapeJavadoc(const std::string& input);
94
95} // namespace java
96} // namespace compiler
97} // namespace protobuf
98} // namespace google
99
100#include <google/protobuf/port_undef.inc>
101
102#endif // GOOGLE_PROTOBUF_COMPILER_JAVA_DOC_COMMENT_H__
103