___DOC_CMAKE Namespace Reference

Note they functions defined on CMake, not C/C++. More...

Typedefs
using	ae2f_float = float
	Pre-defined global float type. It is set to float as default.

Functions
function	ae2f_CoreLibTent (param prm_TarName, param prm_TarPreFix, param prm_includeDir, param prm_namespace,...)
	Makes a Library installable.
function	ae2f_CoreTestTent (param prm_LibName, param prm_TestSourcesDir,...)
	Iterates a directory prm_TestSourcesDir and Make a test case for every source.
function	ae2f_CoreUtilityDocTent (param prm_TarName, param prm_includeDir, param prm_namespace,...)
	Generate an interface project for document code for cmake utility functions. Available when ___DOC_CMAKE::ae2f_DOC is ON.
function	ae2f_CoreLibFetch (param prm_AuthorName, param prm_TarName, param prm_TagName)
	It will try to fetch the cmake project ae2f-Core like project for Local and Github. .
function	ae2f_CoreLibTentConfigCustom (param prm_TarName, param prm_TarPreFix, param prm_includeDir, param prm_namespace, param prm_configpath,...)
	Makes a Library installable. Configuration file could be selected here.

Variables
option	ae2f_DOC = ON
	When activated, it would generate project with the deaders of cmake utility functions.
option	ae2f_IS_SHARED = OFF
	Activating this flag will cause all libraries built as shared libraries.
option	ae2f_TEST = ON
	When activated, it would generate test projects.
CACHE STRING	ae2f_LIBPREFIX = ae2f_IS_SHARED ? "SHARED" : "STATIC"
	Pre-defined library prefix.
CACHE STRING	ae2f_ProjRoot = "${CMAKE_CURRENT_SOURCE_DIR}"
	The root project source directory.
CACHE STRING	ae2f_BinRoot = "${CMAKE_CURRENT_BINARY_DIR}"
	The root binary directory.
constexpr unsigned int	ae2f_packcount = 0
	Set the structure pack for pre-defined structures from interfaces.
option	ae2f_CXX = OFF
	Tell that thou art including cxx for thy project. Default value is [OFF].

Detailed Description

Note they functions defined on CMake, not C/C++.

Typedef Documentation

ae2f_float

using ___DOC_CMAKE::ae2f_float = float

Pre-defined global float type.
It is set to float as default.

Definition at line 38 of file Core.cmake.hpp.

Function Documentation

ae2f_CoreLibFetch()

function ___DOC_CMAKE::ae2f_CoreLibFetch	(	param	prm_AuthorName,
		param	prm_TarName,
		param	prm_TagName )

It will try to fetch the cmake project ae2f-Core like project for Local and Github.
.

See also

___DOC_CMAKE::ae2f_LibDirGlob is the given path to check.

Once the project is in given directory, it will not try to fetch it from internet.

Parameters

prm_AuthorName	Author name
prm_TarName	Target name must be the repository's name.
prm_TagName	Tag name

ae2f_CoreLibTent()

function ___DOC_CMAKE::ae2f_CoreLibTent	(	param	prm_TarName,
		param	prm_TarPreFix,
		param	prm_includeDir,
		param	prm_namespace,
			... )

Makes a Library installable.

Parameters

prm_TarName	Library name you want.
prm_TarPrefix	[STATIC | SHARED | INTERFACE]
prm_includeDir	The include directory relative to the project CMakeLists.txt
prm_namespace	Namespace (or header root directory after include)
...	The sources for the project.

ae2f_CoreLibTentConfigCustom()

function ___DOC_CMAKE::ae2f_CoreLibTentConfigCustom	(	param	prm_TarName,
		param	prm_TarPreFix,
		param	prm_includeDir,
		param	prm_namespace,
		param	prm_configpath,
			... )

Makes a Library installable.
Configuration file could be selected here.

Parameters

prm_TarName	Library name you want.
prm_TarPrefix	[STATIC | SHARED | INTERFACE]
prm_includeDir	The include directory relative to the project CMakeLists.txt
prm_namespace	Namespace (or header root directory after include)
prm_configpath	The path where the input file for Configuration lies.
...	The sources for the project.

ae2f_CoreTestTent()

function ___DOC_CMAKE::ae2f_CoreTestTent	(	param	prm_LibName,
		param	prm_TestSourcesDir,
			... )

Iterates a directory prm_TestSourcesDir and Make a test case for every source.

Parameters

prm_LibName	Base Library name
prm_TestSourcesDir	A directory where the stand-alone test codes locate. Every sources under that directory must be stand-alone, which means it must not depends on another memory, function, etc.
...	Additional Libraries if you want

See also

___DOC_CMAKE::ae2f_TEST

ae2f_CoreUtilityDocTent()

function ___DOC_CMAKE::ae2f_CoreUtilityDocTent	(	param	prm_TarName,
		param	prm_includeDir,
		param	prm_namespace,
			... )

Generate an interface project for document code for cmake utility functions.
Available when ___DOC_CMAKE::ae2f_DOC is ON.

Parameters

prm_TarName	Library name you want.
prm_includeDir	Where the documents exist The include directory relative to the project CMakeLists.txt
prm_namespace	Namespace (or header root directory after include)
...	The past documents name

See also

___DOC_CMAKE::ae2f_CoreLibTent

___DOC_CMAKE::ae2f_DOC

Variable Documentation

ae2f_BinRoot

CACHE STRING ___DOC_CMAKE::ae2f_BinRoot = "${CMAKE_CURRENT_BINARY_DIR}"

The root binary directory.

Definition at line 25 of file Core.cmake.hpp.

ae2f_CXX

option ___DOC_CMAKE::ae2f_CXX = OFF

Tell that thou art including cxx for thy project. Default value is [OFF].

Definition at line 24 of file Core.cmake.hpp.

ae2f_DOC

option ___DOC_CMAKE::ae2f_DOC = ON

When activated, it would generate project with the deaders of cmake utility functions.

Default value is ON.

Definition at line 8 of file Core.cmake.hpp.

ae2f_IS_SHARED

option ___DOC_CMAKE::ae2f_IS_SHARED = OFF

Activating this flag will cause all libraries built as shared libraries.

Definition at line 12 of file Core.cmake.hpp.

ae2f_LIBPREFIX

CACHE STRING ___DOC_CMAKE::ae2f_LIBPREFIX = ae2f_IS_SHARED ? "SHARED" : "STATIC"

Pre-defined library prefix.

Warning

Note that value is auto-generated.

Definition at line 19 of file Core.cmake.hpp.

ae2f_packcount

unsigned int ___DOC_CMAKE::ae2f_packcount = 0

constexpr

Set the structure pack for pre-defined structures from interfaces.

If it is set to zero, default structure pack will be preserved.

Default value is 0.

Definition at line 33 of file Core.cmake.hpp.

ae2f_ProjRoot

CACHE STRING ___DOC_CMAKE::ae2f_ProjRoot = "${CMAKE_CURRENT_SOURCE_DIR}"

The root project source directory.

Definition at line 22 of file Core.cmake.hpp.

ae2f_TEST

option ___DOC_CMAKE::ae2f_TEST = ON

When activated, it would generate test projects.

Definition at line 15 of file Core.cmake.hpp.