overte/tools/jsdoc/hifi-jsdoc-template/tmpl/method.tmpl

<?js
var data = obj;
var self = this;
?>
<?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
    <table>
        <thead>
            <tr>
                <th>
                    <span id="<?js= id ?>" class="member"><?js= data.attribs + (kind === 'class' ? 'new ' : '') + name + (data.signature || '') ?></span>
                    <?js if (data.returns && returns.length) { ?><br />
                        Returns: <span style="font-weight: normal;">
                        <?js returns.forEach(function(r) { ?>
                            <?js= self.partial('returns.tmpl', r) ?>
                        <?js }); ?>
                        </span>
                    <?js } ?>
                    <?js if (data.kind === 'typedef' && data.type && data.type.names) { ?>
                        <br />Type: <?js= self.partial('type.tmpl', data.type.names) ?>
                    <?js } ?>
                </th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>
                    <?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
                        <?js if (data.description) { ?>
                            <?js= self.partial('description.tmpl', data.description) ?>
                        <?js } ?>
                        <?js= this.partial('details.tmpl', data) ?>
                    <?js } else { ?>
                        <p style="color:red;">&nbsp;</p>
                    <?js } ?>                    

                    <?js if (data.exceptions && exceptions.length) { ?>
                    <h3 class="subHeading">Throws</h3>
                    <?js if (exceptions.length > 1) { ?><ul><?js
                    exceptions.forEach(function(r) { ?>
                        <li><?js= self.partial('exceptions.tmpl', r) ?></li>
                    <?js });
                    ?></ul><?js } else {
                    exceptions.forEach(function(r) { ?>
                        <?js= self.partial('exceptions.tmpl', r) ?>
                    <?js });
                    } } ?>

                    

                    <?js if (data.params && params.length && !data.hideconstructor) { ?>
                        <h3 class="subHeading">Parameters</h3>
                        <?js= this.partial('params.tmpl', params) ?>
                    <?js } ?>
                    <?js if (data.examples && examples.length) { ?>
                        <h5>Example<?js= examples.length > 1? 's':'' ?></h5>
                        <?js= this.partial('examples.tmpl', examples) ?>
                    <?js } ?>
                  
                </td>
            </tr>
        </tbody>
    </table>
<?js } ?>

<?js if (data.augments && data.alias && data.alias.indexOf('module:') === 0) { ?>
    <h5>Extends:</h5>
    <?js= self.partial('augments.tmpl', data) ?>
<?js } ?>

<?js if (data.kind === 'event' && data.type && data.type.names) {?>
    <h5>Type:</h5>
    <ul>
        <li>
            <?js= self.partial('type.tmpl', data.type.names) ?>
        </li>
    </ul>
<?js } ?>

<?js if (data['this']) { ?>
    <h5>This:</h5>
    <ul><li><?js= this.linkto(data['this'], data['this']) ?></li></ul>
<?js } ?>

<?js if (data.kind !== 'module' && data.requires && data.requires.length) { ?>
<h5>Requires:</h5>
<ul><?js data.requires.forEach(function(r) { ?>
    <li><?js= self.linkto(r) ?></li>
<?js }); ?></ul>
<?js } ?>

<?js if (data.fires && fires.length) { ?>
<h5>Fires:</h5>
<ul><?js fires.forEach(function(f) { ?>
    <li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>

<?js if (data.listens && listens.length) { ?>
<h5>Listens to Events:</h5>
<ul><?js listens.forEach(function(f) { ?>
    <li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>

<?js if (data.listeners && listeners.length) { ?>
<h5>Listeners of This Event:</h5>
<ul><?js listeners.forEach(function(f) { ?>
    <li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>

<?js if (data.yields && yields.length) { ?>
<h5>Yields:</h5>
<?js if (yields.length > 1) { ?><ul><?js
    yields.forEach(function(r) { ?>
        <li><?js= self.partial('returns.tmpl', r) ?></li>
    <?js });
?></ul><?js } else {
    yields.forEach(function(r) { ?>
        <?js= self.partial('returns.tmpl', r) ?>
    <?js });
} } ?>