Add ability to define multiple-line descriptions #209

Closed
kaishin opened this Issue Sep 19, 2014 · 8 comments

Comments

Projects
None yet
4 participants
@kaishin

kaishin commented Sep 19, 2014

It would be very helpful to have parameter descriptions allow new lines to make some long descriptions more readable. Currently the entire description needs to be in a single line.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Sep 19, 2014

Member

For the record, @kaishin is talking about @param but it could be cool for any annotation with a description (@require, @return, @output...).

Member

HugoGiraudel commented Sep 19, 2014

For the record, @kaishin is talking about @param but it could be cool for any annotation with a description (@require, @return, @output...).

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Sep 19, 2014

Member

It's mostly a parsing issue at this point so @FWeinb is going to tell.

Member

HugoGiraudel commented Sep 19, 2014

It's mostly a parsing issue at this point so @FWeinb is going to tell.

@HugoGiraudel HugoGiraudel removed the Bug label Sep 19, 2014

@HugoGiraudel HugoGiraudel changed the title from Multiple-line parameter descriptions to Add ability to define multiple-line descriptions Sep 19, 2014

@pascalduez

This comment has been minimized.

Show comment
Hide comment
@pascalduez

pascalduez Sep 19, 2014

Member

+1 I also had some cases where I wanted to do that.

Member

pascalduez commented Sep 19, 2014

+1 I also had some cases where I wanted to do that.

@FWeinb

This comment has been minimized.

Show comment
Hide comment
@FWeinb

FWeinb Sep 19, 2014

Member

So i have

  • @param
  • @require
  • @return
  • @output
  • @deprecated
  • @author
  • @prop
  • @since
  • @throws
  • @todo

Anything else?

Member

FWeinb commented Sep 19, 2014

So i have

  • @param
  • @require
  • @return
  • @output
  • @deprecated
  • @author
  • @prop
  • @since
  • @throws
  • @todo

Anything else?

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Sep 19, 2014

Member

Updating tests would be nice.

Member

HugoGiraudel commented Sep 19, 2014

Updating tests would be nice.

@FWeinb

This comment has been minimized.

Show comment
Hide comment
@FWeinb

FWeinb Sep 19, 2014

Member

I did exactly that.

Member

FWeinb commented Sep 19, 2014

I did exactly that.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Sep 19, 2014

Member

You're some kind of super-hero.

Member

HugoGiraudel commented Sep 19, 2014

You're some kind of super-hero.

@kaishin

This comment has been minimized.

Show comment
Hide comment
@kaishin

kaishin Sep 19, 2014

You guys are the best.

kaishin commented Sep 19, 2014

You guys are the best.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment