1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc.  All rights reserved.
3// http://code.google.com/p/protobuf/
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
40namespace google {
41namespace protobuf {
42  namespace io {
43    class Printer;             // printer.h
44  }
45}
46
47namespace protobuf {
48namespace compiler {
49namespace java {
50
51void WriteMessageDocComment(io::Printer* printer, const Descriptor* message);
52void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field);
53void WriteEnumDocComment(io::Printer* printer, const EnumDescriptor* enum_);
54void WriteEnumValueDocComment(io::Printer* printer,
55                              const EnumValueDescriptor* value);
56void WriteServiceDocComment(io::Printer* printer,
57                            const ServiceDescriptor* service);
58void WriteMethodDocComment(io::Printer* printer,
59                           const MethodDescriptor* method);
60
61// Exposed for testing only.
62string EscapeJavadoc(const string& input);
63
64}  // namespace java
65}  // namespace compiler
66}  // namespace protobuf
67
68}  // namespace google
69#endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_DOC_COMMENT_H__
70