package_info.h revision fbaaef999ba563838ebd00874ed8a1c01fbf286d 
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// This file exists solely to document the google::protobuf::compiler namespace.
36// It is not compiled into anything, but it may be read by an automated
37// documentation generator.
38
39namespace google {
40
41namespace protobuf {
42
43// Implementation of the Protocol Buffer compiler.
44//
45// This package contains code for parsing .proto files and generating code
46// based on them.  There are two reasons you might be interested in this
47// package:
48// - You want to parse .proto files at runtime.  In this case, you should
49//   look at importer.h.  Since this functionality is widely useful, it is
50//   included in the libprotobuf base library; you do not have to link against
51//   libprotoc.
52// - You want to write a custom protocol compiler which generates different
53//   kinds of code, e.g. code in a different language which is not supported
54//   by the official compiler.  For this purpose, command_line_interface.h
55//   provides you with a complete compiler front-end, so all you need to do
56//   is write a custom implementation of CodeGenerator and a trivial main()
57//   function.  You can even make your compiler support the official languages
58//   in addition to your own.  Since this functionality is only useful to those
59//   writing custom compilers, it is in a separate library called "libprotoc"
60//   which you will have to link against.
61namespace compiler {}
62
63}  // namespace protobuf
64}  // namespace google
65