3939
4040If you are new to CMake, check out the [ CMake tutorial] [ cmtut ] first.
4141
42- To find the newest * Mathematica* installation in a CMake listfile , run the ` find_package `
42+ To find the newest * Mathematica* installation in a CMake list file , run the ` find_package `
4343command:
4444
4545 find_package(Mathematica)
@@ -48,7 +48,7 @@ The FindMathematica module will look for a *Mathematica* installation in the def
4848location of the used platform. Under Windows it will also use installation locations from the
4949Windows Registry. Under OS X it will also query the Launch Services database.
5050
51- By default FindMathematica will return the newest * Mathematica* installation it can find.
51+ By default, FindMathematica will return the newest * Mathematica* installation it can find.
5252To find a minimum version of * Mathematica* , run the ` find_package ` command with a version
5353argument:
5454
@@ -130,7 +130,7 @@ prompt:
130130
131131Under [ Cygwin] [ cgwn ] the FindMathematica module requires the Cygwin version of CMake, which is
132132different to the regular Windows CMake version.
133- To build the FindMathematica project open a Cygwin shell prompt and run the the following
133+ To build the FindMathematica project open a Cygwin shell prompt and run the following
134134commands in the ` FindMathematica ` root directory:
135135
136136 $ mkdir build
@@ -218,7 +218,7 @@ support `x86_64`. To get a workable project set CMake's target architecture to 3
218218 $ cmake "-DCMAKE_OSX_ARCHITECTURES=i386" ..
219219
220220Used Variables
221- -------------
221+ --------------
222222
223223The module uses the following variables upon the invocation of ` find_package ` :
224224
@@ -252,12 +252,12 @@ The module defines the following variables:
252252* ` Mathematica_SYSTEM_ID ` - default build target platform * Mathematica* System ID (e.g., ` "Windows" ` or ` "Linux" ` )
253253* ` Mathematica_SYSTEM_IDS ` - list of supported build target platform * Mathematica* System IDs (e.g., ` "MacOSX" ` , ` "MacOSX-x86" ` , ` "MacOSX-x86-64" ` )
254254* ` Mathematica_HOST_SYSTEM_ID ` - default host platform * Mathematica* System ID (e.g., ` "Windows-x86-64" ` or ` "MacOSX-x86-64" ` )
255- * ` Mathematica_HOST_SYSTEM_IDS ` - list of * Mathematica* System IDs available with host * Mathematica* installation
255+ * ` Mathematica_HOST_SYSTEM_IDS ` - list of * Mathematica* System IDs available with the host * Mathematica* installation
256256* ` Mathematica_ROOT_DIR ` - * Mathematica* installation directory valid for build target platform
257257* ` Mathematica_HOST_ROOT_DIR ` - * Mathematica* installation directory valid for host platform (corresponds to ` $InstallationDirectory ` )
258258* ` Mathematica_KERNEL_EXECUTABLE ` - path to host * Mathematica* kernel executable
259259* ` Mathematica_FRONTEND_EXECUTABLE ` - path to host * Mathematica* frontend executable
260- * ` Mathematica_BASE_DIR ` - directory for systemwide files to be loaded by * Mathematica* (corresponds to ` $BaseDirectory ` )
260+ * ` Mathematica_BASE_DIR ` - directory for system wide files to be loaded by * Mathematica* (corresponds to ` $BaseDirectory ` )
261261* ` Mathematica_USERBASE_DIR ` - directory for user-specific files to be loaded by * Mathematica* (corresponds to ` $UserBaseDirectory ` )
262262* ` Mathematica_INCLUDE_DIR ` - header file ` mdefs.h ` include directory
263263* ` Mathematica_INCLUDE_DIRS ` - list of include directories for all components
@@ -297,8 +297,8 @@ The module defines the following variables for component `MathLink`:
297297* ` Mathematica_MathLink_LIBRARY ` - path to MathLink library for default target platform
298298* ` Mathematica_MathLink_LIBRARIES ` - MathLink library for all target platforms and required system libraries
299299* ` Mathematica_MathLink_MPREP_EXECUTABLE ` - path to host ` mprep ` executable (MathLink template file preprocessor)
300- * ` Mathematica_MathLink_HOST_INCLUDE_DIR ` - header file mathlink.h include directory for host platform
301- * ` Mathematica_MathLink_DEFINITIONS ` - MathLink compile definitions, e.g., " -DMLINTERFACE=3"
300+ * ` Mathematica_MathLink_HOST_INCLUDE_DIR ` - header file ` mathlink.h ` include directory for host platform
301+ * ` Mathematica_MathLink_DEFINITIONS ` - MathLink compile definitions, e.g., ` -DMLINTERFACE=3
302302* ` Mathematica_MathLink_LINKER_FLAGS ` - MathLink linker flags
303303* ` Mathematica_MathLink_VERSION ` - MathLink version number given as "interface.revision"
304304* ` Mathematica_MathLink_VERSION_MAJOR ` - MathLink interface number
@@ -318,7 +318,7 @@ The module defines the following variables for component `WSTP`:
318318* ` Mathematica_WSTP_LIBRARIES ` - WSTP library for all target platforms and required system libraries
319319* ` Mathematica_WSTP_WSPREP_EXECUTABLE ` - path to host ` wsprep ` executable (WSTP template file preprocessor)
320320* ` Mathematica_WSTP_HOST_INCLUDE_DIR ` - header file wstp.h include directory for host platform
321- * ` Mathematica_WSTP_DEFINITIONS ` - WSTP compile definitions, e.g., " -DWSINTERFACE=4"
321+ * ` Mathematica_WSTP_DEFINITIONS ` - WSTP compile definitions, e.g., ` -DWSINTERFACE=4 `
322322* ` Mathematica_WSTP_LINKER_FLAGS ` - WSTP linker flags
323323* ` Mathematica_WSTP_VERSION ` - WSTP version number given as "interface.revision"
324324* ` Mathematica_WSTP_VERSION_MAJOR ` - WSTP interface number
@@ -393,7 +393,7 @@ script file. Multiple in-line statements are wrapped inside a *Mathematica* `Com
393393
394394If the optional ` CACHE ` argument is specified, the captured result of the executed * Mathematica*
395395code is added to a cache variable named ` <output variable> ` . The execution will not be repeated
396- unless the variable is cleared or the result is the * Mathematica* expression ` $Failed ` or
396+ unless the variable is cleared, or the result is the * Mathematica* expression ` $Failed ` or
397397` $Aborted ` , or a false CMake constant.
398398
399399The ` SYSTEM_ID ` option lets you override the * Mathematica* kernel executable architecture used.
@@ -586,7 +586,7 @@ LibraryLink (this requires at least *Mathematica* 8).
586586 [ OUTPUT <C source file> ])
587587
588588This function uses the CCodeGenerator package to convert * Mathematica* code to C code that can be
589- run independently from * Mathematica* . Upon running the C code only requires the Wolfram Runtime
589+ run independently of * Mathematica* . Upon running the C code only requires the Wolfram Runtime
590590Library.
591591
592592The * Mathematica* script file needs to set up definitions of compiled functions and return a list
@@ -636,7 +636,7 @@ function `Splice` has been deprecated as of *Mathematica* 10.
636636This function adds a custom command which runs the * Mathematica* function ` Encode ` on the given input
637637files. * Mathematica* encoded files contain only printable ASCII characters.
638638
639- By default each encoded output files is created with the same name as the corresponding input file
639+ By default, each encoded output files is created with the same name as the corresponding input file
640640in ` CMAKE_CURRENT_BINARY_DIR ` . The ` OUTPUT ` option can be used to create the output files in
641641a different directory or with different names.
642642
@@ -703,7 +703,7 @@ environment variable to be set.
703703 [ CUSTOM_TRAILER <trailer file> ]
704704 [ LINE_DIRECTIVES ])
705705
706- This functions adds a custom command which creates a C source file from a MathLink template (.tm)
706+ This function adds a custom command which creates a C source file from a MathLink template (.tm)
707707file with ` mprep ` . The generated C source file contains MathLink glue code that makes C functions
708708callable from * Mathematica* via a MathLink connection.
709709
@@ -894,7 +894,7 @@ This function is available if the *Mathematica* kernel executable has been found
894894
895895This function resolves ` TestSuite[{ ... }] ` expressions in the given MUnit test files (.mt or .wlt)
896896into the list of underlying MUnit test files. The test file names are interpreted relative to
897- the test suite file. By default the function returns the absolute paths of the parsed test
897+ the test suite file. By default, the function returns the absolute paths of the parsed test
898898files. If the ` RELATIVE ` option is specified, results will be returned as a relative path to
899899the given path. If a given test file does not contain a ` TestSuite ` expression, its path will
900900be returned instead.
0 commit comments