CMake Integration

The Xentara Workbench plugin library comes with a CMake module named XentaraWorkbenchPlugin. To link a target against the Xentara Workbench plugin library, include the following lines in your CMakeLists.txt file:

find_package(XentaraWorkbenchPlugin REQUIRED)
target_link_libraries(myTarget PRIVATE Xentara::xentara-workbench-plugin)

Replace myTarget with the name of your target.

Targets
Xentara::xentara-workbench-plugin
	The Xentara Workbench plugin library
Variables Note The standard variables set by the find_package command, like XentaraWorkbenchPlugin_FOUND, XentaraWorkbenchPlugin_DIR, and XentaraWorkbenchPlugin_VERSION, are not described in this documentation. Please refer to the documentation of find_package for information on the variables that that command sets.
XentaraWorkbenchPlugin_DOXYGEN_TAG_FILE
	The location of the Doxygen tag file for the Xentara Workbench plugin library documentation More...
XentaraWorkbenchPlugin_HTML_DOC_DIR
	The location of the locally installed Xentara Workbench plugin library documentation More...

Variable Documentation

XentaraWorkbenchPlugin_DOXYGEN_TAG_FILE

XentaraWorkbenchPlugin_DOXYGEN_TAG_FILE

The location of the Doxygen tag file for the Xentara Workbench plugin library documentation.

This variable contains the path to a Doxygen tag file that can be used to link other Doxygen documentation to the Xentara Workbench plugin library documentation. See Linking to external documentation in the Doxygen documentation for details.

XentaraWorkbenchPlugin_HTML_DOC_DIR

XentaraWorkbenchPlugin_HTML_DOC_DIR

The location of the locally installed Xentara Workbench plugin library documentation.

This variable contains the directory where the Xentara Workbench plugin library documentation has been installed. This variable can be used to link to the locally installed version of the documentation. Generally, it is preferrable to link to the online Xentara documentation located at https://docs.xentara.io/xentara-utils/, however.