search

hegemonic / jsdoc-baseline

An experimental, extensible template for JSDoc.
Other
61 stars 32 forks source link

example tag not functioning as expected #151

Closed jobalexander closed 9 years ago

jobalexander commented 9 years ago 
/** @function module:table.caption
   * @param {string} [_x] - Sets value of {@link module:table~caption caption} to _x. If parameter missing then returns current value of {@link module:table~caption caption}.
   * @description Setter/getter function for {@link module:table~caption caption}.
   * @example 
   * <caption>Assume that the table module is referenced as table in the main.js file.</caption>
   * var example_table = table();
   * example_table.caption("Example Table");
   *
   * //returns "Example Table"
   * example_table.caption();
   * */

returns the following: caption

Sorry if this has already been addressed but a quick search through the issues did not result in any obvious hits.

hegemonic commented 9 years ago

Confirmed. I'm investigating. Sorry for the lengthy delay.

hegemonic commented 9 years ago

Fixed on master. If you run into any other issues with this, please feel free to file a new bug!