Updated header file comments

hjagodzinski · Apr 4, 2021 · a61ed31 · a61ed31
1 parent 1aba90d
commit a61ed31
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 20 deletions.
diff --git a/include/cmock/cmock-function-class-mockers.h b/include/cmock/cmock-function-class-mockers.h
@@ -2,7 +2,7 @@
 //     pump.py cmock-function-class-mockers.h.pump
 // DO NOT EDIT BY HAND!!!
 
-// Copyright 2013, Hubert Jagodziński
+// Copyright 2021, Hubert Jagodziński
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -30,10 +30,10 @@
 //
 // Author: hubert.jagodzinski@gmail.com (Hubert Jagodziński)
 
-// C Mock - extension to Google Mock framework allowing for writing C mock
-// functions.
+// C Mock - Google Mock's extension allowing a function mocking.
 //
-// This file implements C function mockers of various arities.
+// This file implements CMockMocker class and CMOCK_MOCK_FUNCTIONn() macros of
+// various arities.
 
 #ifndef CMOCK_INCLUDE_CMOCK_CMOCK_FUNCTION_CLASS_MOCKERS_H_
 #define CMOCK_INCLUDE_CMOCK_CMOCK_FUNCTION_CLASS_MOCKERS_H_

diff --git a/include/cmock/cmock-function-class-mockers.h.pump b/include/cmock/cmock-function-class-mockers.h.pump
@@ -4,7 +4,7 @@ $$ cmock-function-mockers.h.  Pump (pump.py) can be found in
 $$ googletest/scripts.
 $$
 $var n = 10  $$ The maximum arity we support.
-// Copyright 2013, Hubert Jagodziński
+// Copyright 2021, Hubert Jagodziński
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -32,9 +32,9 @@ $var n = 10  $$ The maximum arity we support.
 //
 // Author: hubert.jagodzinski@gmail.com (Hubert Jagodziński)
 
-// C Mock - extension to Google Mock framework allowing for writing C mock functions.
+// C Mock - Google Mock's extension allowing a function mocking.
 //
-// This file implements C function mockers of various arities.
+// This file implements CMockMocker class and CMOCK_MOCK_FUNCTIONn() macros of various arities.
 
 #ifndef CMOCK_INCLUDE_CMOCK_CMOCK_FUNCTION_CLASS_MOCKERS_H_
 #define CMOCK_INCLUDE_CMOCK_CMOCK_FUNCTION_CLASS_MOCKERS_H_

diff --git a/include/cmock/cmock-function-mockers.h b/include/cmock/cmock-function-mockers.h
@@ -2,7 +2,7 @@
 //     pump.py cmock-function-mockers.h.pump
 // DO NOT EDIT BY HAND!!!
 
-// Copyright 2013, Hubert Jagodziński
+// Copyright 2021, Hubert Jagodziński
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -30,10 +30,10 @@
 //
 // Author: hubert.jagodzinski@gmail.com (Hubert Jagodziński)
 
-// C Mock - extension to Google Mock framework allowing for writing C mock
-// functions.
+// C Mock - Google Mock's extension allowing a function mocking.
 //
-// This file implements C function mockers of various arities.
+// This file implements DECLARE_FUNCTION_MOCKn() and IMPLEMENT_FUNCTION_MOCKn()
+// macros of various arities.
 
 #ifndef CMOCK_INCLUDE_CMOCK_CMOCK_FUNCTION_MOCKERS_H_
 #define CMOCK_INCLUDE_CMOCK_CMOCK_FUNCTION_MOCKERS_H_

diff --git a/include/cmock/cmock-function-mockers.h.pump b/include/cmock/cmock-function-mockers.h.pump
@@ -4,7 +4,7 @@ $$ cmock-function-mockers.h.  Pump (pump.py) can be found in
 $$ googletest/scripts.
 $$
 $var n = 10  $$ The maximum arity we support.
-// Copyright 2013, Hubert Jagodziński
+// Copyright 2021, Hubert Jagodziński
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -32,9 +32,9 @@ $var n = 10  $$ The maximum arity we support.
 //
 // Author: hubert.jagodzinski@gmail.com (Hubert Jagodziński)
 
-// C Mock - extension to Google Mock framework allowing for writing C mock functions.
+// C Mock - Google Mock's extension allowing a function mocking.
 //
-// This file implements C function mockers of various arities.
+// This file implements DECLARE_FUNCTION_MOCKn() and IMPLEMENT_FUNCTION_MOCKn() macros of various arities.
 
 #ifndef CMOCK_INCLUDE_CMOCK_CMOCK_FUNCTION_MOCKERS_H_
 #define CMOCK_INCLUDE_CMOCK_CMOCK_FUNCTION_MOCKERS_H_

diff --git a/include/cmock/cmock-spec-builders.h b/include/cmock/cmock-spec-builders.h
@@ -1,4 +1,4 @@
-// Copyright 2013, Hubert Jagodziński
+// Copyright 2021, Hubert Jagodziński
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -26,9 +26,9 @@
 //
 // Author: hubert.jagodzinski@gmail.com (Hubert Jagodziński)
 
-// C Mock - extension to Google Mock framework allowing for writing C mock functions.
+// C Mock - Google Mock's extension allowing a function mocking.
 //
-// This file implements the ON_FUNCTION_CALL() and EXPECT_FUNCTION_CALL() macros.
+// This file implements ON_FUNCTION_CALL() and EXPECT_FUNCTION_CALL() macros.
 
 #ifndef CMOCK_INCLUDE_CMOCK_CMOCK_SPEC_BUILDERS_H_
 #define CMOCK_INCLUDE_CMOCK_CMOCK_SPEC_BUILDERS_H_

diff --git a/include/cmock/cmock.h b/include/cmock/cmock.h
@@ -1,4 +1,4 @@
-// Copyright 2013, Hubert Jagodziński
+// Copyright 2021, Hubert Jagodziński
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -26,9 +26,9 @@
 //
 // Author: hubert.jagodzinski@gmail.com (Hubert Jagodziński)
 
-// C Mock - extension to Google Mock framework allowing for writing C mock functions.
+// C Mock - Google Mock's extension allowing a function mocking.
 //
-// This is the main header file a user should include.
+// This is the main header file an user should include.
 
 #ifndef CMOCK_INCLUDE_CMOCK_CMOCK_H_
 #define CMOCK_INCLUDE_CMOCK_CMOCK_H_