소스 검색

TestCXXAcceptsFlag: Update documentation (#14657)

Document this module as deprecated and link to CheckCXXCompilerFlag.
Fix cut-n-paste-o and format macro signature.
Brad King 12 년 전
부모
커밋
95c705a6a9
1개의 변경된 파일9개의 추가작업 그리고 7개의 파일을 삭제
  1. 9 7
      Modules/TestCXXAcceptsFlag.cmake

+ 9 - 7
Modules/TestCXXAcceptsFlag.cmake

@@ -2,16 +2,18 @@
 # TestCXXAcceptsFlag
 # ------------------
 #
-# Test CXX compiler for a flag
+# Deprecated.  See :module:`CheckCXXCompilerFlag`.
 #
-# Check if the CXX compiler accepts a flag
+# Check if the CXX compiler accepts a flag.
 #
-# ::
+# .. code-block:: cmake
 #
-#   Macro CHECK_CXX_ACCEPTS_FLAG(FLAGS VARIABLE) -
-#      checks if the function exists
-#   FLAGS - the flags to try
-#   VARIABLE - variable to store the result
+#  CHECK_CXX_ACCEPTS_FLAG(<flags> <variable>)
+#
+# ``<flags>``
+#  the flags to try
+# ``<variable>``
+#  variable to store the result
 
 #=============================================================================
 # Copyright 2002-2009 Kitware, Inc.