Browse Source

REFA,DOC: Added Doc removed empty lines

dev-feat-component_preview
chris 2 months ago
parent
commit
439a98eb33
  1. 6
      src/base/extStore.js
  2. 4
      src/component/Component.js
  3. 17
      src/generators/generator.js

6
src/base/extStore.js

@ -385,7 +385,7 @@ class ExtStorage {
} }
/** /**
* * Returns a function that will setup the distribution of a given styling.
* @returns {function(SStoreDefinition,HTMLElement,number): boolean} * @returns {function(SStoreDefinition,HTMLElement,number): boolean}
*/ */
getStylingDistribution() { getStylingDistribution() {
@ -576,7 +576,8 @@ function identifyAndResolveOverwrite(targetContainer, compareKey, newValue, over
} }
/** /**
* * Creates a new Script Tag
* and then fills the given css rules into it.
* @param {Array<SStoreDefinition>} ssdArray * @param {Array<SStoreDefinition>} ssdArray
* @returns {HTMLScriptElement} * @returns {HTMLScriptElement}
*/ */
@ -595,6 +596,7 @@ function generateAndFillScriptTag(ssdArray) {
return tag; return tag;
} }
/** /**
* *
* @param {string} selector * @param {string} selector

4
src/component/Component.js

@ -395,7 +395,7 @@ class Component extends StyleAndScriptStoringComponent {
/** /**
* Ends chain. * Ends chain.
* Applies all modifications on the element. * Applies all modifications on the element.
* Processes alls stored additions. * Processes all stored additions.
* Returns the constructed HTMLElement of this Component. * Returns the constructed HTMLElement of this Component.
* *
* @param {CompelGenerator} generator * @param {CompelGenerator} generator
@ -557,6 +557,4 @@ class Component extends StyleAndScriptStoringComponent {
return _wenity; return _wenity;
} }
} }

17
src/generators/generator.js

@ -1,5 +1,5 @@
/** /**
* This module defines the Component generator. * This class defines the Component generator.
* It externalizes all decision making about script or style storage from the component. * It externalizes all decision making about script or style storage from the component.
* The component stores the generator (if set, if not =default or passed down from parent component). * The component stores the generator (if set, if not =default or passed down from parent component).
* The CompelGenerator class enables the setup/definition of storage, generation and distribution. * The CompelGenerator class enables the setup/definition of storage, generation and distribution.
@ -13,7 +13,6 @@
* Therefore the usages of CompelGenerator-feature-logic resets all style and script storages to local. * Therefore the usages of CompelGenerator-feature-logic resets all style and script storages to local.
* Only towards the end (when "generate()" is called) any of that will be resolved. * Only towards the end (when "generate()" is called) any of that will be resolved.
*/ */
class CompelGenerator { class CompelGenerator {
/** /**
* @param {null} [styleStore=null] * @param {null} [styleStore=null]
@ -24,8 +23,11 @@ class CompelGenerator {
this._functionStore = functionStore; this._functionStore = functionStore;
} }
/** /**
* Deals with the direct component stylings
* @param {Component} component * @param {Component} component
* @param {Array<WebTrinity>} childrenWenity
* @param {ExtStorage} extStore * @param {ExtStorage} extStore
* @returns {Array<SStoreDefinition>} * @returns {Array<SStoreDefinition>}
*/ */
@ -63,8 +65,12 @@ class CompelGenerator {
return forCollection; return forCollection;
} }
/** /**
* First deals with the scripts/functions.
* *
* @param {Component} component
* @param {Array<WebTrinity>} childrenWenity
* @param {ExtStorage} extStore * @param {ExtStorage} extStore
* @returns {Array<SStoreDefinition>} * @returns {Array<SStoreDefinition>}
*/ */
@ -127,7 +133,14 @@ class CompelGenerator {
return childWT; return childWT;
} }
/** /**
* Iterates over the children of the component
* and calls generate on each child.
* The resulting compext (the text of the component) is added/appended accordingly.
* If the generation returns with delegatable scripts or styles
* the WebTrinity object is collected in an array,
* which will be returned.
* *
* @param {Component} component * @param {Component} component
* @returns {Array<WebTrinity>} * @returns {Array<WebTrinity>}

Loading…
Cancel
Save