Skip to content

Commit

Permalink
update generated cmake api
Browse files Browse the repository at this point in the history
  • Loading branch information
dirk-thomas committed Jan 28, 2014
1 parent 790de41 commit 5d8d244
Showing 1 changed file with 119 additions and 0 deletions.
119 changes: 119 additions & 0 deletions doc/dev_guide/generated_cmake_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,15 @@ Public CMake functions / macros
* :cmake:macro:`catkin_add_gtest`
* :cmake:macro:`catkin_add_nosetests`
* :cmake:macro:`catkin_download_test_data`
* :cmake:macro:`catkin_filter_libraries_for_build_configuration`
* :cmake:macro:`catkin_install_python`
* :cmake:macro:`catkin_metapackage`
* :cmake:macro:`catkin_pack_libraries_with_build_configuration`
* :cmake:macro:`catkin_package`
* :cmake:macro:`catkin_package_xml`
* :cmake:macro:`catkin_python_setup`
* :cmake:macro:`catkin_replace_imported_library_targets`
* :cmake:macro:`catkin_unpack_libraries_with_build_configuration`

.. _`catkin_add_env_hooks_ref`:

Expand Down Expand Up @@ -163,6 +168,51 @@ Public CMake functions / macros
:type MD5: string


.. _`catkin_filter_libraries_for_build_configuration_ref`:

`catkin_filter_libraries_for_build_configuration`
-------------------------------------------------

.. cmake:macro:: catkin_filter_libraries_for_build_configuration(VAR)
*[macro defined in catkin_libraries.cmake]*


Filter libraries based on optional build configuration keywords.

:param VAR: the output variable name
:type VAR: string
:param ARGN: a list of libraries
:type ARGN: list of strings
:param BUILD_TYPE: a keyword for the build type (default:
``CMAKE_BUILD_TYPE``)
:type BUILD_TYPE: list of strings



.. _`catkin_install_python_ref`:

`catkin_install_python`
-----------------------

.. cmake:macro:: catkin_install_python(signature)
*[function defined in catkin_install_python.cmake]*


Install Python files and update their shebang lines
to use a different Python executable.

The signature:

catkin_install_python(PROGRAMS files... DESTINATION <dir>
[OPTIONAL]
)

See the documentation for CMake install() function for more information.



.. _`catkin_metapackage_ref`:

`catkin_metapackage`
Expand All @@ -186,6 +236,27 @@ Public CMake functions / macros



.. _`catkin_pack_libraries_with_build_configuration_ref`:

`catkin_pack_libraries_with_build_configuration`
------------------------------------------------

.. cmake:macro:: catkin_pack_libraries_with_build_configuration(VAR)
*[macro defined in catkin_libraries.cmake]*


Pack a list of libraries with optional build configuration keywords.
Each keyword is joined with its library using a separator.
A packed library list can be deduplicated correctly.

:param VAR: the output variable name
:type VAR: string
:param ARGN: a list of libraries
:type ARGN: list of strings



.. _`catkin_package_ref`:

`catkin_package`
Expand Down Expand Up @@ -333,6 +404,45 @@ Public CMake functions / macros



.. _`catkin_replace_imported_library_targets_ref`:

`catkin_replace_imported_library_targets`
-----------------------------------------

.. cmake:macro:: catkin_replace_imported_library_targets(VAR)
*[macro defined in catkin_libraries.cmake]*


Replace imported library target names with the library name.

:param VAR: the output variable name
:type VAR: string
:param ARGN: a list of libraries
:type ARGN: list of strings



.. _`catkin_unpack_libraries_with_build_configuration_ref`:

`catkin_unpack_libraries_with_build_configuration`
--------------------------------------------------

.. cmake:macro:: catkin_unpack_libraries_with_build_configuration(VAR)
*[macro defined in catkin_libraries.cmake]*


Unpack a list of libraries with optional build configuration keyword prefixes.
Libraries prefixed with a keyword are split into the keyword and the library.

:param VAR: the output variable name
:type VAR: string
:param ARGN: a list of libraries
:type ARGN: list of strings



Non-public CMake functions / macros
-----------------------------------

Expand Down Expand Up @@ -606,6 +716,15 @@ Not documented CMake functions / macros
*[function defined in assert.cmake]*

.. _`atomic_configure_file_ref`:

`atomic_configure_file`
-----------------------

.. cmake:macro:: atomic_configure_file(input, output)
*[function defined in atomic_configure_file.cmake]*

.. _`catkin_doxygen_ref`:

`catkin_doxygen`
Expand Down

0 comments on commit 5d8d244

Please sign in to comment.