kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

FindProtobuf: Cleanup reStructuredText documentation formatting 

Fix the markup to make the documentation format properly.
This commit is contained in:
Brad King 2014-11-06 13:49:32 -05:00
parent 8dab50636d
commit 6c4aa388a5
1 changed files with 56 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
Modules/FindProtobuf.cmake
View File

@ -2,127 +2,80 @@
# FindProtobuf # FindProtobuf
# ------------ # ------------
# #
#
#
# Locate and configure the Google Protocol Buffers library. # Locate and configure the Google Protocol Buffers library.
# #
# The following variables can be set and are optional: # The following variables can be set and are optional:
# #
# :: # ``PROTOBUF_SRC_ROOT_FOLDER``
# # When compiling with MSVC, if this cache variable is set
# PROTOBUF_SRC_ROOT_FOLDER - When compiling with MSVC, if this cache variable is set
# the protobuf-default VS project build locations # the protobuf-default VS project build locations
# (vsprojects/Debug & vsprojects/Release) will be searched # (vsprojects/Debug & vsprojects/Release) will be searched
# for libraries and binaries. # for libraries and binaries.
# # ``PROTOBUF_IMPORT_DIRS``
# # List of additional directories to be searched for
# # imported .proto files.
# ::
#
# PROTOBUF_IMPORT_DIRS - List of additional directories to be searched for
# imported .proto files. (New in CMake 2.8.8)
#
#
# #
# Defines the following variables: # Defines the following variables:
# #
# :: # ``PROTOBUF_FOUND``
# # Found the Google Protocol Buffers library
# PROTOBUF_FOUND - Found the Google Protocol Buffers library (libprotobuf & header files) # (libprotobuf & header files)
# PROTOBUF_INCLUDE_DIRS - Include directories for Google Protocol Buffers # ``PROTOBUF_INCLUDE_DIRS``
# PROTOBUF_LIBRARIES - The protobuf libraries # Include directories for Google Protocol Buffers
# # ``PROTOBUF_LIBRARIES``
# [New in CMake 2.8.5] # The protobuf libraries
# # ``PROTOBUF_PROTOC_LIBRARIES``
# :: # The protoc libraries
# # ``PROTOBUF_LITE_LIBRARIES``
# PROTOBUF_PROTOC_LIBRARIES - The protoc libraries # The protobuf-lite libraries
# PROTOBUF_LITE_LIBRARIES - The protobuf-lite libraries
#
#
# #
# The following cache variables are also available to set or use: # The following cache variables are also available to set or use:
# #
# :: # ``PROTOBUF_LIBRARY``
# The protobuf library
# ``PROTOBUF_PROTOC_LIBRARY``
# The protoc library
# ``PROTOBUF_INCLUDE_DIR``
# The include directory for protocol buffers
# ``PROTOBUF_PROTOC_EXECUTABLE``
# The protoc compiler
# ``PROTOBUF_LIBRARY_DEBUG``
# The protobuf library (debug)
# ``PROTOBUF_PROTOC_LIBRARY_DEBUG``
# The protoc library (debug)
# ``PROTOBUF_LITE_LIBRARY``
# The protobuf lite library
# ``PROTOBUF_LITE_LIBRARY_DEBUG``
# The protobuf lite library (debug)
# #
# PROTOBUF_LIBRARY - The protobuf library
# PROTOBUF_PROTOC_LIBRARY - The protoc library
# PROTOBUF_INCLUDE_DIR - The include directory for protocol buffers
# PROTOBUF_PROTOC_EXECUTABLE - The protoc compiler
#
# [New in CMake 2.8.5]
#
# ::
#
# PROTOBUF_LIBRARY_DEBUG - The protobuf library (debug)
# PROTOBUF_PROTOC_LIBRARY_DEBUG - The protoc library (debug)
# PROTOBUF_LITE_LIBRARY - The protobuf lite library
# PROTOBUF_LITE_LIBRARY_DEBUG - The protobuf lite library (debug)
#
#
#
# ::
#
# ====================================================================
# Example: # Example:
# #
# # .. code-block:: cmake
#
# ::
# #
# find_package(Protobuf REQUIRED) # find_package(Protobuf REQUIRED)
# include_directories(${PROTOBUF_INCLUDE_DIRS}) # include_directories(${PROTOBUF_INCLUDE_DIRS})
#
#
#
# ::
#
# include_directories(${CMAKE_CURRENT_BINARY_DIR}) # include_directories(${CMAKE_CURRENT_BINARY_DIR})
# PROTOBUF_GENERATE_CPP(PROTO_SRCS PROTO_HDRS foo.proto) # protobuf_generate_cpp(PROTO_SRCS PROTO_HDRS foo.proto)
# add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS}) # add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS})
# target_link_libraries(bar ${PROTOBUF_LIBRARIES}) # target_link_libraries(bar ${PROTOBUF_LIBRARIES})
# #
# .. note::
# The PROTOBUF_GENERATE_CPP macro and add_executable() or
# add_library() calls only work properly within the same
# directory.
# #
# .. command:: protobuf_generate_cpp
# #
# NOTE: You may need to link against pthreads, depending # Add custom commands to process ``.proto`` files::
# #
# :: # protobuf_generate_cpp (<SRCS> <HDRS> [<ARGN>...])
# #
# on the platform. # ``SRCS``
# # Variable to define with autogenerated source files
# # ``HDRS``
# # Variable to define with autogenerated header files
# NOTE: The PROTOBUF_GENERATE_CPP macro & add_executable() or # ``ARGN``
# add_library() # ``.proto`` files
#
# ::
#
# calls only work properly within the same directory.
#
#
#
# ::
#
# ====================================================================
#
#
#
# PROTOBUF_GENERATE_CPP (public function)
#
# ::
#
# SRCS = Variable to define with autogenerated
# source files
# HDRS = Variable to define with autogenerated
# header files
# ARGN = proto files
#
#
#
# ::
#
# ====================================================================
#============================================================================= #=============================================================================
# Copyright 2009 Kitware, Inc. # Copyright 2009 Kitware, Inc.