浏览代码

📝 Add documentation to Component class

Pedro Schneider 3 年之前
父节点
当前提交
481496af29
共有 1 个文件被更改,包括 15 次插入0 次删除
  1. 15 0
      pandora/components/Component.js

+ 15 - 0
pandora/components/Component.js

@@ -19,8 +19,23 @@
  * along with Pandora.  If not, see <https://www.gnu.org/licenses/>.
  *************************************************************************/
 
+/**
+ * This {@code Component} class represents the base class all Components inherit from.
+ * 
+ * ! This is an empty class the serves only to be inherited from to organize the hierarchy.
+ * ! This class should not bet used by the user.
+ * 
+ * @author Pedro Schneider
+ * 
+ * @class
+ */
 class Component
 {
+    /**
+     * Creates an empty Component.
+     * 
+     * @constructor
+     */
     constructor()
     {}
 }