[Gin] Add documentation to explain how Gin works
This code is likely to evolve over time, but we've reached a stage where the
basic structure is mostly in place. This CL documents this structure so that
future developers will understand what we have in mind now.
[email protected]
BUG=none
Review URL: https://codereview.chromium.org/88913006
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@237485 0039d316-1c4b-4281-b951-d872f2087c98
diff --git a/gin/test/file_runner.h b/gin/test/file_runner.h
index c4164f5..57d4017d 100644
--- a/gin/test/file_runner.h
+++ b/gin/test/file_runner.h
@@ -12,6 +12,11 @@
namespace gin {
+// FileRunnerDelegate is a simple RunnerDelegate that's useful for running
+// tests. The FileRunnerDelegate provides built-in modules for "console" and
+// "gtest" that are useful when writing unit tests.
+//
+// TODO(abarth): Rename FileRunnerDelegate to TestRunnerDelegate.
class FileRunnerDelegate : public ModuleRunnerDelegate {
public:
FileRunnerDelegate();
diff --git a/gin/test/gtest.h b/gin/test/gtest.h
index ee19b715..2bd69447 100644
--- a/gin/test/gtest.h
+++ b/gin/test/gtest.h
@@ -9,6 +9,9 @@
namespace gin {
+// This module provides bindings to gtest. Most tests should use an idiomatic
+// JavaScript testing API, but this module is available for tests that need a
+// low-level integration with gtest.
class GTest {
public:
static const char kModuleName[];
diff --git a/gin/test/v8_test.h b/gin/test/v8_test.h
index 6ad52d6..e62aa570e 100644
--- a/gin/test/v8_test.h
+++ b/gin/test/v8_test.h
@@ -15,7 +15,8 @@
class IsolateHolder;
-// A base class for tests that use v8.
+// V8Test is a simple harness for testing interactions with V8. V8Test doesn't
+// have any dependencies on Gin's module system.
class V8Test : public testing::Test {
public:
V8Test();
