Просмотр исходного кода

📝 Add documentation to Component class

Pedro Schneider 3 лет назад
Родитель
Сommit
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()
     {}
 }