Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
12 Jul 2015 at 07:55 UTC
Updated:
14 Sep 2015 at 16:14 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
eiriksmComment #2
eiriksmComment #3
dawehnerDo you mind describing that this object consists of 'view_args' and 'view_path'
Comment #4
eiriksmGood point.
Just tried something, did not know it was allowed in jsDoc, but it is.:
This produces the output attached. Which is very descriptive. Should we do something like this? Have not seen it done like this other places, and not in PHP docs either. So, a suggestion I guess.

Comment #5
dawehnerIt is quite astonishing how much you can do with jsdoc.
Comment #6
eiriksmSo is that a "go" for this solution? :)
Maybe we should get some js/doc maintainers to look at it as well?
Comment #7
eiriksmTalked to @nod_ in IRC, he also thought this
@returnstuff looked good. Submitted a question to the jsdoc team to be 100% sure this is supported (since this is not in the jsdoc doc).Comment #8
eiriksmFound this discussion on the jsdoc mailing list:
https://groups.google.com/forum/#!searchin/jsdoc-users/@return/jsdoc-users/TMvUedK9tC4/jQW3UBTaBR4J
This solution is in that answer called "faking it". Not sure if we should conclude with that that means it is supported :p
One thing we could do would be number 3 there. But it is a bit verbose though. Thoughts?
Comment #9
nod_Let's not fake it. Just need the description to be explicit about what is in the object, we can discuss later about generalizing the use of custom types for this kind of things.
Comment #10
nod_Comment #11
webchickCommitted and pushed to 8.0.x. Thanks!