Skip to content
Snippets Groups Projects
Verified Commit 608820b7 authored by Timm Fitschen's avatar Timm Fitschen
Browse files

DOC: refined code docs for form_elements

parent f5fc1634
No related branches found
No related tags found
1 merge request!37prepare release v0.3.1
......@@ -84,16 +84,17 @@ var form_elements = new function () {
/**
* The configuration for double, integer, date input elements.
*
* There are specializations of this configuration object. See
* {@link ReferenceDropDownConfig}, {@link RangeFieldConfig}.
* There are several specializations of this configuration object.
* {@link ReferenceDropDownConfig}, {@link RangeFieldConfig}, {@link SelectFieldConfig}, {@link FileFieldConfig}
*
* @typedef {object} FieldConfig
*
* @property {string} name
* @property {string} type
* @property {string} label
* @see {@link ReferenceDropDownConfig}
* @see {@link RangeFieldConfig}
* @property {string} [label]
* @property {string} [help]
* @property {boolean} [required=false]
* @property {boolean} [cached=false]
*/
this.version = "0.1";
......@@ -402,10 +403,9 @@ var form_elements = new function () {
* defined by `label`. If the `label` property is undefined, the `name`
* is shown instead.
*
* The ReferenceDropDownConfig is a specialisation of a
* {@link FieldConfig}.
*
* @typedef {option} ReferenceDropDownConfig
*
* @augments FieldConfig
* @property {string} name - The name of the select input.
* @property {string} query - Query for entities.
* @property {function} [make_value] - Call-back for the generation of
......@@ -419,8 +419,6 @@ var form_elements = new function () {
* @property {string} [type] - This should be "reference_drop_down" or
* undefined. This property is used by `make_form_field` to decide
* which type of field is to be generated.
*
* @see {@link FieldConfig}
*/
this._query = async function (q) {
......@@ -1598,4 +1596,4 @@ var form_elements = new function () {
$(document).ready(function () {
caosdb_modules.register(form_elements);
});
\ No newline at end of file
});
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment