Pārlūkot izejas kodu

Improving comments

Richard Knight 6 gadi atpakaļ
vecāks
revīzija
d77c327684
1 mainītis faili ar 8 papildinājumiem un 6 dzēšanām
  1. 8 6
      src/app/dynaform/services/dynaform.service.ts

+ 8 - 6
src/app/dynaform/services/dynaform.service.ts

@@ -13,16 +13,18 @@
  * meta is optional, and if not supplied all the model fields will become Text inputs in the FormGroup,
  * with their labels set to the un-camel-cased property name
  *
- * createFromMeta is optional. If true it will create new fields in the FormGroup when they don't already exist in the model.
- * If defaults to false, except when a completly empty model {} is supplied.
+ * createFromMeta is optional.
+ * If true it will create new fields in the FormGroup even when they don't already exist in the model,
+ * but exist in the metadata. This is NOT the default behaviour, except when an empty model is supplied.
+ * i.e. It defaults to false, except when model == {}
  *
  * USAGE
  * -----
  *
- * build(model)
- * build({}, meta)
- * build(model, meta)
- * build(model, meta, true)
+ * build(model)				- build everything from the model
+ * build({}, meta)			- build everything from the metadata
+ * build(model, meta)		- build by combining the model with metadata, lazyily (not every model field needs metadata, as sensible defaults)
+ * build(model, meta, true)	- build by combing model with metadata, creating new fields from metadata points not in the model
  *
  *
  * LOWER-LEVEL METHODS