feat(#61): doc

objectionary · May 29, 2024 · 93d8dcb · 93d8dcb
1 parent 2c3efb4
commit 93d8dcb
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/eo2js-runtime/test/fake/org/eolang/cage.js b/eo2js-runtime/test/fake/org/eolang/cage.js
@@ -1,4 +1,9 @@
-
+/**
+ * Fake CAGE EO object that is used for the test purposes.
+ * Don't change the file until you definitely know what you're doing.
+ * For more information please read README.md in test/fake folder
+ * @return {Object} - Object
+ */
 const cage = function() {
   const object = require('../../../runtime/object')
   const attr = require('../../../runtime/attribute/attr')
@@ -30,6 +35,12 @@ const cage = function() {
   return obj
 }
 
+/**
+ * Fake CAGE.ENCAGED EO object that is used for the test purposes.
+ * Don't change the file until you definitely know what you're doing.
+ * For more information please read README.md in test/fake folder
+ * @return {Object} - Object
+ */
 const cage$encaged = function() {
   const object = require('../../../runtime/object')
   const attr = require('../../../runtime/attribute/attr')
@@ -60,4 +71,5 @@ const cage$encaged = function() {
   )
   return obj
 }
+
 module.exports = cage