From 801b799f9d5f1d904c4605d19b798ed489be925d Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 9 Jun 2015 10:21:07 -0400 Subject: [PATCH] FindBISON: Improve documentation formatting --- Modules/FindBISON.cmake | 78 +++++++++++++++++++++++------------------ 1 file changed, 44 insertions(+), 34 deletions(-) diff --git a/Modules/FindBISON.cmake b/Modules/FindBISON.cmake index ec3ee78e8..4002cc608 100644 --- a/Modules/FindBISON.cmake +++ b/Modules/FindBISON.cmake @@ -2,60 +2,70 @@ # FindBISON # --------- # -# Find bison executable and provides macros to generate custom build rules +# Find ``bison`` executable and provide a macro to generate custom build rules. # # The module defines the following variables: # -# :: +# ``BISON_EXECUTABLE`` +# path to the ``bison`` program # -# BISON_EXECUTABLE - path to the bison program -# BISON_VERSION - version of bison -# BISON_FOUND - true if the program was found +# ``BISON_VERSION`` +# version of ``bison`` # +# ``BISON_FOUND`` +# true if the program was found # +# The minimum required version of ``bison`` can be specified using the +# standard CMake syntax, e.g. ``find_package(BISON 2.1.3)``. # -# The minimum required version of bison can be specified using the -# standard CMake syntax, e.g. find_package(BISON 2.1.3) +# If ``bison`` is found, the module defines the macro:: # -# If bison is found, the module defines the macros: +# BISON_TARGET( +# [COMPILE_FLAGS ] +# [VERBOSE ] +# ) # -# :: -# -# BISON_TARGET( [VERBOSE ] -# [COMPILE_FLAGS ]) -# -# which will create a custom rule to generate a parser. is -# the path to a yacc file. is the name of the source file +# which will create a custom rule to generate a parser. ```` is +# the path to a yacc file. ```` is the name of the source file # generated by bison. A header file is also be generated, and contains -# the token list. If COMPILE_FLAGS option is specified, the next -# parameter is added in the bison command line. if VERBOSE option is -# specified, is created and contains verbose descriptions of the -# grammar and parser. The macro defines a set of variables: +# the token list. # -# :: +# The options are: # -# BISON_${Name}_DEFINED - true is the macro ran successfully -# BISON_${Name}_INPUT - The input source file, an alias for -# BISON_${Name}_OUTPUT_SOURCE - The source file generated by bison -# BISON_${Name}_OUTPUT_HEADER - The header file generated by bison -# BISON_${Name}_OUTPUTS - The sources files generated by bison -# BISON_${Name}_COMPILE_FLAGS - Options used in the bison command line +# ``COMPILE_FLAGS `` +# Specify flags to be added to the ``bison`` command line. # +# ``VERBOSE `` +# Tell ``bison`` to write verbose descriptions of the grammar and +# parser to the given ````. # +# The macro defines the following variables: # -# :: +# ``BISON__DEFINED`` +# true is the macro ran successfully # -# ==================================================================== -# Example: +# ``BISON__INPUT`` +# The input source file, an alias for # +# ``BISON__OUTPUT_SOURCE`` +# The source file generated by bison # +# ``BISON__OUTPUT_HEADER`` +# The header file generated by bison # -# :: +# ``BISON__OUTPUTS`` +# The sources files generated by bison # -# find_package(BISON) -# BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp) -# add_executable(Foo main.cpp ${BISON_MyParser_OUTPUTS}) -# ==================================================================== +# ``BISON__COMPILE_FLAGS`` +# Options used in the ``bison`` command line +# +# Example usage: +# +# .. code-block:: cmake +# +# find_package(BISON) +# BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp) +# add_executable(Foo main.cpp ${BISON_MyParser_OUTPUTS}) #============================================================================= # Copyright 2009 Kitware, Inc.