question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

@file or @overview tags ignored

See original GitHub issue

Summary

jsdoc tags @file and its synonims @overview and @fileoverview seem to be ignored by jsdoc-to-markdown

Steps to reproduce

Create a file with the following contents:

'use strict';

/**
 * @file A sample file
 */

/**
 * @function foo
 */
function foo () {
  return 'bar';
}

Run jsdoc2md:

$ jsdoc2md file.js
<a name="foo"></a>

## foo()
**Kind**: global function

As you can see the contents for the @file tag are not included in the generated markdown.

Other information

Using version 1.3.6. of jsdoc-to-markdown

Issue Analytics

  • State:open
  • Created 7 years ago
  • Reactions:5
  • Comments:5 (1 by maintainers)

github_iconTop GitHub Comments

1reaction
ornerydcommented, Jul 24, 2017

I figured out a workaround. just use the “@name” tag instead and just give your file a name without an extension. then it will pick up the comments regardless. just don’t use “@file” or synonyms or it will still ignore it even when using “@name

0reactions
dmnsgncommented, Feb 26, 2022

I’d be interested in this feature too 👍

Read more comments on GitHub >

github_iconTop Results From Across the Web

About the Tag coverage summary - Tag Manager Help
To accept a suggested page as part of your summary, hover on a row, and click Add . You may also click Ignore...
Read more >
Why is Google ignoring my title tag or meta description?
Sometimes Google will ignore the title tag or meta description that you set for a particular page on your website. This can occur...
Read more >
Email HTML tags & attributes ignored by Outlook
On this article we focus on the exact HTML tags, attributes and parameters that are ignored by popular email clients, such as Outlook,...
Read more >
ignore - phpDocumentor
Description. The @ignore tag tells phpDocumentor that the Structural Elements associated with the tag should not to be processed. An typical use-case would ......
Read more >
Reading xml file and ignoring inside XML tags
Above script works, but - if in my source file I replace "This is my text" to "<p>This is my text</p>", then this...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found