documentationjs / documentationjs/documentation

File-level comments misapplied

Open
#1,384 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

Using Documentation 13.2.5 and running it through yarn with the command

"documentation build --github --markdown-toc --config documentation.yml -f html src/utils/** -o docs/jsDocumentation"

I want to supply file-level documentation. My source file has:

```
/**
* @file Utilities to manage Event Schema Files (.esf files)
* @author David Goldfarb
*/

/**
* Just a random function.
*/
const f = () => 42;
```

The file comments are applied to a ghost second copy of `f`:

![image](https://user-images.githubusercontent.com/62514146/125442996-bbce0777-10e0-44f9-97a1-115f4b603d9f.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.