@return tag supports complex object

[davglass]

If a return value is an object with a complex structure, you can nest @param tags underneath the @return value.

[HeikoR]

This would be a great feature extension. Spent some time searching google on how to do this until I found this issue.
+1

Thanks for a great tool.

[lukemadera]

I've been looking for this for a long time! @davglass are there any usage examples or documentation for this? And does this exist for @Property as well? Basically anytime an object is used, it needs nested support - are we always to use @param?

Is this how it's used?

@return {Object} The return object
  @param {String} str1 A string
  @param {Object} ob1 A nested object
    @param {Number} number1 A number

[andreu86]

+1, this would be great

[digitil]

+1 this would remove the need for awkward workarounds

[lexander]

Is @param the correct idea or does @attribute better capture what is being described?

[qraynaud]

+1

Also I suppose that @Attribute would be more sensitive but it would require to make the same change on the parameters. That would be breaking a lot... Or should it support both?

[luxocrates]

+1

This would be monumentally useful.

[lexander]

@qraynaud seems like most people prefer @param (assuming they'd have chimed in if they liked the alternative). So if @attribute would break stuff, we should drop that idea.

[tgirardi]

+1

[wbyoung]

+1

[qraynaud]

@lexander I don't mind really. I was suggesting this change because technically those aren't params and it can be kind of confusing. But really, it's fine either way with me ^^.

[CraigFeldspar]

+1

[okuryu]

Okay, I'll take a look in the near future. 😄

[anagami]

Hello!
Have any progress for this issue?

[okuryu]

I'm working in progress on this.

[chopper]

+1 Any update on this?

[qraynaud]

@chopper it is my understanding that this package is not supported anymore, you should migrate on another one

[chopper]

@qraynaud YUIDoc in general is not supported anymore?

[qraynaud]

At least it looks like it yes. But I might be wrong...