cibernox / ember-cli-yuidoc

EmberCLI addon for generate documentation from YUIDoc coments
MIT License
55 stars 25 forks source link

Two issues with crossLink #42

Closed adamdonahue closed 7 years ago

adamdonahue commented 8 years ago

We're using ember-cli-yuidoc but are running into a couple issues with crossLink.

First, we sometimes document our components like this:

/**
 * Component my-foo.
 *
 * Usage:
 *      {{my-foo x=y}}
 *
 * @class MyFooComponent
 */

This works fine, and generates the expected output. But if we use {{#crossLink in the description, that cross link isn't generated (instead the raw {{#crossLink text is displayed as if it hadn't been parsed).

/**
 * Component my-foo.  Takes an {{#crossLink 'X'}}x{{/crossLink}} and presents it.
 *
 * Usage:
 *      {{my-foo x=y}}
 *
 * @class MyFooComponent
 */

That is, the crossLink in the second example isn't parsed.

Second issue is that linking to a method or attribute within a class doesn't seem to work at all:

{{#crossLink 'X/id:property'}}model ID{{/crossLink}}

where id is an inherited property from DS.Model.

Are we doing something wrong?