@borrows only creates static members on namespaces
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
In a scenario like the one below, bar won't be an inner function of the namespace Foo, but rather a static function called Foo(NS)~bar.
/** @namespace Foo(NS)
* @borrows Foo#bar as Foo(NS)~bar
*/
window.Foo = (function(){
/** @class Foo
*/
function Foo(){ }
/** This sets bla as inner member
* @private
* @memberof Foo#
*/
function bar() { }
Foo.prototype.bar = bar;
return Foo;
})();
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the @borrows handling and reproduce the JavaScript example from the issue. Check how Foo#bar and Foo(NS)~bar are resolved, then verify that bar is documented as an inner member of Foo rather than only as a static namespace function.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100