Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inherited method description does not escape HTML #324

Closed
garysoed opened this issue Mar 10, 2015 · 5 comments · Fixed by #341 or #343
Closed

Inherited method description does not escape HTML #324

garysoed opened this issue Mar 10, 2015 · 5 comments · Fixed by #341 or #343
Assignees
Labels
Milestone

Comments

@garysoed
Copy link

For example:

/**
 * @class ability.Ability
 */

/**
 * Returns the trigger for this ability on this element.
 * @method getTrigger
 */

/**
 * @constructor
 * @class ability.Droppable
 * @extends ability.Ability
 */

output in ability.Droppable:

<p>Returns the trigger for this ability on this element.</p>
@okuryu
Copy link
Member

okuryu commented Mar 10, 2015

Thanks! It seems to be a bug. I'll take a look.

@hhff
Copy link

hhff commented Mar 29, 2015

hi @okuryu - reporting this as well:

screen shot 2015-03-29 at 6 05 23 pm

@okuryu
Copy link
Member

okuryu commented Mar 31, 2015

@hhff Thanks! I'm working on this. :)

okuryu added a commit to okuryu/yuidoc that referenced this issue Apr 9, 2015
All descriptions and examples of inherited classes was parsed markdown
by markdown-it twice. This fixes yui#324.
@okuryu okuryu added this to the v0.7.0 milestone Apr 12, 2015
@okuryu okuryu self-assigned this Apr 12, 2015
okuryu added a commit to okuryu/yuidoc that referenced this issue Apr 15, 2015
@okuryu
Copy link
Member

okuryu commented Apr 29, 2015

Published yuidocjs@0.7.0.

@vmaudgalya
Copy link

Hi @okuryu I'm using yuidocjs@0.10.0

I've found that when adding the comments:

/**
* Gets user info
*
* @method getUserInfo
* @return {Object} Returns JSON object containing todos and notifications for the user.
*/

The generated HTML is as follows:

<div class="returns" id="yui_3_9_1_2_1456452399664_459">
  <h4>Returns:</h4>
    <div class="returns-description" id="yui_3_9_1_2_1456452399664_458">
      <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
         <p>Returns JSON object containing todos and notifications for the user.</p>
    </div>
</div>

You can see that there's an extra <p> tag, in the "Returns" statement. Is this a bug, or is there some way to suppress this?

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