dgeni icon indicating copy to clipboard operation
dgeni copied to clipboard

"Missing container document" Warning on memberDocsProcessor

Open bigmeech opened this issue 9 years ago • 3 comments

hi, What could be the issue with this doc.

/**
         * @ngdoc method
         * @name prep.factory:prepParams#parameters
         * @description Set new parameters or get current parameters
         *
         * @param {string} newParameters      New parameters
         * @param {string} parseParamsFromUrl Flag if parse parameters like in url
         * @returns {Object} Current parameters or `this`
         */

when this gets processed by the memberDocsProcessor, i get the warning below and this doc gets excluded from the docs collection passed down to the next processor.

 Missing container document: "method:prep.factory:prepParams" - doc "method:prep.factory:prepParams#parameters" (method)  - from file "../../scripts/prep.js"

Any help with this guys? is my doc badly formatted?

bigmeech avatar Apr 15 '15 16:04 bigmeech

I had the same issue, it seems to be a kind of bug. As a workaround try to refactor->rename prep.factory:prepParams if it is possible and check if warning remains.

ivorobkalo avatar Jan 05 '16 12:01 ivorobkalo

It is probably because the ngdoc package is not clever enough to understand that prep.factory:prepParams is a valid service.

petebacondarwin avatar Jan 05 '16 12:01 petebacondarwin

I had same issue with a service named mx.shell.SidePanel Probably issue author experience different issue

ivorobkalo avatar Jan 06 '16 08:01 ivorobkalo