aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGennadiy Civil <misterg@google.com>2019-08-02 13:26:55 -0400
committerGennadiy Civil <misterg@google.com>2019-08-02 13:26:55 -0400
commitcc34e8fa7ccae09ab12a54abed0eb6d912a12bb5 (patch)
tree21a6579ece32721a74d99870d45ea687e21ff746
parent47092933fde8d08773ac98c011b311d82f858e22 (diff)
parent287b37f23f534a0f9b1eb6072c882cbcaaffc097 (diff)
downloadgoogletest-cc34e8fa7ccae09ab12a54abed0eb6d912a12bb5.tar.gz
googletest-cc34e8fa7ccae09ab12a54abed0eb6d912a12bb5.tar.bz2
googletest-cc34e8fa7ccae09ab12a54abed0eb6d912a12bb5.zip
Merge pull request #2357 from kuzkry:obsolete-documentation
PiperOrigin-RevId: 261343928
-rw-r--r--googlemock/include/gmock/gmock-generated-actions.h9
-rw-r--r--googlemock/include/gmock/gmock-generated-actions.h.pump9
-rw-r--r--googlemock/include/gmock/gmock-generated-matchers.h7
-rw-r--r--googlemock/include/gmock/gmock-generated-matchers.h.pump7
-rwxr-xr-xgooglemock/scripts/upload.py2
-rwxr-xr-xgoogletest/scripts/gen_gtest_pred_impl.py14
-rwxr-xr-xgoogletest/scripts/pump.py2
-rwxr-xr-xgoogletest/scripts/upload.py2
8 files changed, 22 insertions, 30 deletions
diff --git a/googlemock/include/gmock/gmock-generated-actions.h b/googlemock/include/gmock/gmock-generated-actions.h
index bf95300b..981af78f 100644
--- a/googlemock/include/gmock/gmock-generated-actions.h
+++ b/googlemock/include/gmock/gmock-generated-actions.h
@@ -259,11 +259,10 @@ class ActionHelper {
//
// CAVEAT:
//
-// ACTION*() can only be used in a namespace scope. The reason is
-// that C++ doesn't yet allow function-local types to be used to
-// instantiate templates. The up-coming C++0x standard will fix this.
-// Once that's done, we'll consider supporting using ACTION*() inside
-// a function.
+// ACTION*() can only be used in a namespace scope as templates cannot be
+// declared inside of a local class.
+// Users can, however, define any local functors (e.g. a lambda) that
+// can be used as actions.
//
// MORE INFORMATION:
//
diff --git a/googlemock/include/gmock/gmock-generated-actions.h.pump b/googlemock/include/gmock/gmock-generated-actions.h.pump
index 39e65c33..209603c5 100644
--- a/googlemock/include/gmock/gmock-generated-actions.h.pump
+++ b/googlemock/include/gmock/gmock-generated-actions.h.pump
@@ -182,11 +182,10 @@ $template
//
// CAVEAT:
//
-// ACTION*() can only be used in a namespace scope. The reason is
-// that C++ doesn't yet allow function-local types to be used to
-// instantiate templates. The up-coming C++0x standard will fix this.
-// Once that's done, we'll consider supporting using ACTION*() inside
-// a function.
+// ACTION*() can only be used in a namespace scope as templates cannot be
+// declared inside of a local class.
+// Users can, however, define any local functors (e.g. a lambda) that
+// can be used as actions.
//
// MORE INFORMATION:
//
diff --git a/googlemock/include/gmock/gmock-generated-matchers.h b/googlemock/include/gmock/gmock-generated-matchers.h
index b6f34bdd..690a57f1 100644
--- a/googlemock/include/gmock/gmock-generated-matchers.h
+++ b/googlemock/include/gmock/gmock-generated-matchers.h
@@ -250,11 +250,8 @@
// overloading matchers based on parameter types (as opposed to just
// based on the number of parameters).
//
-// MATCHER*() can only be used in a namespace scope. The reason is
-// that C++ doesn't yet allow function-local types to be used to
-// instantiate templates. The up-coming C++0x standard will fix this.
-// Once that's done, we'll consider supporting using MATCHER*() inside
-// a function.
+// MATCHER*() can only be used in a namespace scope as templates cannot be
+// declared inside of a local class.
//
// More Information
// ================
diff --git a/googlemock/include/gmock/gmock-generated-matchers.h.pump b/googlemock/include/gmock/gmock-generated-matchers.h.pump
index 333dc9df..ae90917c 100644
--- a/googlemock/include/gmock/gmock-generated-matchers.h.pump
+++ b/googlemock/include/gmock/gmock-generated-matchers.h.pump
@@ -252,11 +252,8 @@ $$ }} This line fixes auto-indentation of the following code in Emacs.
// overloading matchers based on parameter types (as opposed to just
// based on the number of parameters).
//
-// MATCHER*() can only be used in a namespace scope. The reason is
-// that C++ doesn't yet allow function-local types to be used to
-// instantiate templates. The up-coming C++0x standard will fix this.
-// Once that's done, we'll consider supporting using MATCHER*() inside
-// a function.
+// MATCHER*() can only be used in a namespace scope as templates cannot be
+// declared inside of a local class.
//
// More Information
// ================
diff --git a/googlemock/scripts/upload.py b/googlemock/scripts/upload.py
index 4b574732..95239dc2 100755
--- a/googlemock/scripts/upload.py
+++ b/googlemock/scripts/upload.py
@@ -631,7 +631,7 @@ class VersionControlSystem(object):
new_content: For text files, this is empty. For binary files, this is
the contents of the new file, since the diff output won't contain
information to reconstruct the current file.
- is_binary: True if the file is binary.
+ is_binary: True iff the file is binary.
status: The status of the file.
"""
diff --git a/googletest/scripts/gen_gtest_pred_impl.py b/googletest/scripts/gen_gtest_pred_impl.py
index b00830d7..b43efdf4 100755
--- a/googletest/scripts/gen_gtest_pred_impl.py
+++ b/googletest/scripts/gen_gtest_pred_impl.py
@@ -540,10 +540,10 @@ class Predicate%(n)sTest : public testing::Test {
}
}
- // true if the test function is expected to run to finish.
+ // true iff the test function is expected to run to finish.
static bool expected_to_finish_;
- // true if the test function did run to finish.
+ // true iff the test function did run to finish.
static bool finished_;
""" % DEFS
@@ -572,12 +572,12 @@ typedef Predicate%(n)sTest ASSERT_PRED%(n)sTest;
"""Returns the test for a predicate assertion macro.
Args:
- use_format: true if the assertion is a *_PRED_FORMAT*.
- use_assert: true if the assertion is a ASSERT_*.
- expect_failure: true if the assertion is expected to fail.
- use_functor: true if the first argument of the assertion is
+ use_format: true iff the assertion is a *_PRED_FORMAT*.
+ use_assert: true iff the assertion is a ASSERT_*.
+ expect_failure: true iff the assertion is expected to fail.
+ use_functor: true iff the first argument of the assertion is
a functor (as opposed to a function)
- use_user_type: true if the predicate functor/function takes
+ use_user_type: true iff the predicate functor/function takes
argument(s) of a user-defined type.
Example:
diff --git a/googletest/scripts/pump.py b/googletest/scripts/pump.py
index 7dfb87a4..5efb653c 100755
--- a/googletest/scripts/pump.py
+++ b/googletest/scripts/pump.py
@@ -161,7 +161,7 @@ class Token:
def StartsWith(lines, pos, string):
- """Returns True if the given position in lines starts with 'string'."""
+ """Returns True iff the given position in lines starts with 'string'."""
return lines[pos.line][pos.column:].startswith(string)
diff --git a/googletest/scripts/upload.py b/googletest/scripts/upload.py
index 8563e5f4..c852e4c9 100755
--- a/googletest/scripts/upload.py
+++ b/googletest/scripts/upload.py
@@ -631,7 +631,7 @@ class VersionControlSystem(object):
new_content: For text files, this is empty. For binary files, this is
the contents of the new file, since the diff output won't contain
information to reconstruct the current file.
- is_binary: True if the file is binary.
+ is_binary: True iff the file is binary.
status: The status of the file.
"""