Определение пользовательского типа ngdoc
Директива, которую я имею в своем проекте, становится большой с большим количеством различных опций
Один из моих параметров называется tableFields у этого объекта есть много опций, которые вы можете добавить к нему:
Для этого я попытался создать typedef (определение типа) однако без везения:
/**
* @typedef tableFields
* @type {object}
* @property {String} headerTitle This string is a translate string this will be evaluated to a translate value and then translated
* @property {Boolean} sortable True/false value sets if the field is sortable. This will also control if the column can be searched by an external source
* @property {Boolean} isImage True/false value if true the field will be considered as a path to an image if so the field will be converted to an image and collected from the APP server. Note that you typically do not want to sort this type of field
* @property {String} fieldKey this key is ALWAYS required it tells the table which key to look for in the tableData object. This key / value is also the one you search for when creating searches.
* @property {String} combineKey an extra key that allows you to bind two keys into one string
*/
/**
* @ngdoc directive
* @name LBTable.directive: lbTable
* @description
* Wrapper for a responsive paginated table. creates a table that allows both sorting and searching.
* Also gives the option to set custom links, callback functions and other important functions
* @param {array} tableData The data which needs to fill the table (The array must be an array of objects)
* @param {tableFields} tableFields object
К сожалению, когда я генерирую свою документацию, она просто дает мне это:
Итак, мой вопрос, как я могу указать требования к полю или сделать определение типа?