浏览代码

-minor doc fixes

Use <VAR> instead of VarName in get_filename_component (as is used in most other
command documentations), and fix the name of the generated project in include_external_msproject(#9743,
the comment there seems to be correct: http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=3d1c12b802c3dd3a0284f5f10aec3b98ab6d3a78#patch9 )

Alex
Alex Neundorf 15 年之前
父节点
当前提交
d1b3ceb88c
共有 2 个文件被更改,包括 8 次插入9 次删除
  1. 6 6
      Source/cmGetFilenameComponentCommand.h
  2. 2 3
      Source/cmIncludeExternalMSProjectCommand.h

+ 6 - 6
Source/cmGetFilenameComponentCommand.h

@@ -62,10 +62,10 @@ public:
   virtual const char* GetFullDocumentation()
     {
     return
-      "  get_filename_component(VarName FileName\n"
+      "  get_filename_component(<VAR> FileName\n"
       "                         PATH|ABSOLUTE|NAME|EXT|NAME_WE|REALPATH\n"
       "                         [CACHE])\n"
-      "Set VarName to be the path (PATH), file name (NAME), file "
+      "Set <VAR> to be the path (PATH), file name (NAME), file "
       "extension (EXT), file name without extension (NAME_WE) of FileName, "
       "the full path (ABSOLUTE), or the full path with all symlinks "
       "resolved (REALPATH).  "
@@ -73,14 +73,14 @@ public:
       "trailing slashes. The longest file extension is always considered. "
       "If the optional CACHE argument is specified, the result variable is "
       "added to the cache.\n"
-      "  get_filename_component(VarName FileName\n"
-      "                         PROGRAM [PROGRAM_ARGS ArgVar]\n"
+      "  get_filename_component(<VAR> FileName\n"
+      "                         PROGRAM [PROGRAM_ARGS <ARG_VAR>]\n"
       "                         [CACHE])\n"
       "The program in FileName will be found in the system search path or "
       "left as a full path.  If PROGRAM_ARGS is present with PROGRAM, then "
       "any command-line arguments present in the FileName string are split "
-      "from the program name and stored in ArgVar.  This is used to separate "
-      "a program name from its arguments in a command line string.";
+      "from the program name and stored in <ARG_VAR>.  This is used to "
+      "separate a program name from its arguments in a command line string.";
     }
   
   cmTypeMacro(cmGetFilenameComponentCommand, cmCommand);

+ 2 - 3
Source/cmIncludeExternalMSProjectCommand.h

@@ -62,9 +62,8 @@ public:
       "                             dep1 dep2 ...)\n"
       "Includes an external Microsoft project in the generated workspace "
       "file.  Currently does nothing on UNIX. This will create a "
-      "target named INCLUDE_EXTERNAL_MSPROJECT_[projectname].  This can "
-      "be used in the add_dependencies command to make things depend "
-      "on the external project.";
+      "target named [projectname].  This can be used in the add_dependencies "
+      "command to make things depend on the external project.";
     }
   
   cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand);