Как документировать свойства свойств сервисов?
Учитывая этот код:
var zomg = angular.module('zomg', []);
/**
* @ngdoc object
* @name zomg.Foo
* @description
* # Foo
*/
zomg.factory('Foo', [function () {
return {
/**
* @ngdoc object
* @name zomg.Foo.bar
* @propertyOf zomg.Foo
* @description
* A property of Foo
*/
bar: {
/**
* @ngdoc object
* @name zomg.Foo.bar.baz
* @propertyOf zomg.Foo.bar
* @description
* A property of Foo.bar
*/
baz: 100
}
};
}]);
Я получаю эту документацию:
Это Foo.bar.baz
свойство не отображается в документации. Разбирается правильно - так как если я изменю @propertyOf
от zomg.Foo.bar
что-то вроде zomg.Foo.doesnotexist
, Я получаю ошибку при компиляции документации. Но результаты не отображаются в результирующем HTML.
Как мне документировать вложенные объекты? Фактический случай использования заключается в том, что у меня есть служба, которая содержит $resource
с, и я хочу документировать специальные методы на $resource
, Я бы предпочел сделать это стандартным способом jsdoc (@ngdoc function
с @methodOf
самой специальной функции), а не включать ее в @description
из $resource
нестандартным способом.