From fea3b11ca01677e60d552ac29091b28946c99f08 Mon Sep 17 00:00:00 2001 From: Alex Merry Date: Sun, 1 Feb 2015 12:02:14 +0000 Subject: Minor documentation syntax fixes. --- modules/ECMCoverageOption.cmake | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'modules/ECMCoverageOption.cmake') diff --git a/modules/ECMCoverageOption.cmake b/modules/ECMCoverageOption.cmake index 8d435de8..92fcf74d 100644 --- a/modules/ECMCoverageOption.cmake +++ b/modules/ECMCoverageOption.cmake @@ -11,10 +11,7 @@ # # If it's on, the project will be compiled with code coverage support, using # gcov. Otherwise, it will be built normally. -# -# :: -# -# + #============================================================================= # Copyright 2014 Aleix Pol Gonzalez # -- cgit v1.2.1 From a1d6d8f7259ade901a87b33edbef8b31bffb5e26 Mon Sep 17 00:00:00 2001 From: Alex Merry Date: Fri, 6 Feb 2015 11:31:19 +0000 Subject: Document when modules were added to ECM. --- modules/ECMCoverageOption.cmake | 2 ++ 1 file changed, 2 insertions(+) (limited to 'modules/ECMCoverageOption.cmake') diff --git a/modules/ECMCoverageOption.cmake b/modules/ECMCoverageOption.cmake index 92fcf74d..4cfe6641 100644 --- a/modules/ECMCoverageOption.cmake +++ b/modules/ECMCoverageOption.cmake @@ -11,6 +11,8 @@ # # If it's on, the project will be compiled with code coverage support, using # gcov. Otherwise, it will be built normally. +# +# Since 1.3.0. #============================================================================= # Copyright 2014 Aleix Pol Gonzalez -- cgit v1.2.1 From ce678b32de12e6bb3c2b470111a3fcbadcca3a38 Mon Sep 17 00:00:00 2001 From: Alex Merry Date: Fri, 6 Feb 2015 11:50:31 +0000 Subject: Add missing documentation. Three modules (ECMCoverageOption, ECMEnableSanitizers and ECMGeneratePkgConfigFile) were not being documented. This commit fixes that situation. --- modules/ECMCoverageOption.cmake | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'modules/ECMCoverageOption.cmake') diff --git a/modules/ECMCoverageOption.cmake b/modules/ECMCoverageOption.cmake index 4cfe6641..4c1db9de 100644 --- a/modules/ECMCoverageOption.cmake +++ b/modules/ECMCoverageOption.cmake @@ -2,15 +2,17 @@ # ECMCoverageOption # -------------------- # -# Creates a BUILD_COVERAGE option, so the project can be built with code coverage -# support. +# Allow users to easily enable GCov code coverage support. # -# :: +# Code coverage allows you to check how much of your codebase is covered by +# your tests. This module makes it easy to build with support for +# `GCov `_. # -# BUILD_COVERAGE +# When this module is included, a ``BUILD_COVERAGE`` option is added (default +# OFF). Turning this option on enables GCC's coverage instrumentation, and +# links against ``libgcov``. # -# If it's on, the project will be compiled with code coverage support, using -# gcov. Otherwise, it will be built normally. +# Note that this will probably break the build if you are not using GCC. # # Since 1.3.0. -- cgit v1.2.1