Просмотр исходного кода

STYLE: improve IF documentation to cover elseif

Ken Martin 19 лет назад
Родитель
Сommit
2888b13ef9
1 измененных файлов с 8 добавлено и 2 удалено
  1. 8 2
      Source/cmIfCommand.h

+ 8 - 2
Source/cmIfCommand.h

@@ -99,6 +99,11 @@ public:
       "    COMMAND1(ARGS ...)\n"
       "    COMMAND1(ARGS ...)\n"
       "    COMMAND2(ARGS ...)\n"
       "    COMMAND2(ARGS ...)\n"
       "    ...\n"
       "    ...\n"
+      "  ELSEIF(expression2)\n"
+      "    # ELSEIF section.\n"
+      "    COMMAND1(ARGS ...)\n"
+      "    COMMAND2(ARGS ...)\n"
+      "    ...\n"
       "  ELSE(expression)\n"
       "  ELSE(expression)\n"
       "    # ELSE section.\n"
       "    # ELSE section.\n"
       "    COMMAND1(ARGS ...)\n"
       "    COMMAND1(ARGS ...)\n"
@@ -107,8 +112,9 @@ public:
       "  ENDIF(expression)\n"
       "  ENDIF(expression)\n"
       "Evaluates the given expression.  If the result is true, the commands "
       "Evaluates the given expression.  If the result is true, the commands "
       "in the THEN section are invoked.  Otherwise, the commands in the "
       "in the THEN section are invoked.  Otherwise, the commands in the "
-      "ELSE section are invoked.  The ELSE section is optional.  Note that "
-      "the same expression must be given to IF, ELSE, and ENDIF.  Long "
+      "ELSE section are invoked.  The ELSEIF and ELSE sections are "
+      "optional. You may have multiple ELSEIF clauses. Note that "
+      "the same expression must be given to IF, and ENDIF.  Long "
       "expressions can be used and the order or precedence is that the "
       "expressions can be used and the order or precedence is that the "
       "EXISTS, COMMAND, and DEFINED operators will be evaluated first. "
       "EXISTS, COMMAND, and DEFINED operators will be evaluated first. "
       "Then any EQUAL, LESS, GREATER, STRLESS, STRGREATER, STREQUAL, MATCHES "
       "Then any EQUAL, LESS, GREATER, STRLESS, STRGREATER, STREQUAL, MATCHES "