documentation

documentation copied to clipboard

Error when dealing with multiple exports

8

I get this error on 5.3.3: ``` Error: Parsing file C:\Users\CMCDragonkai\Projects\js-virtualfs\lib\index.js: 'import' and 'export' may appear only with 'sourceType: module' (3:0) at Deps.parseDeps (C:\Users\CMCDragonkai\Projects\js-virtualfs\node_modules\module-deps-sortable\index.js:467:28) at fromSource (C:\Users\CMCDragonkai\Projects\js-virtualfs\node_modules\module-deps-sortable\index.js:402:44) at C:\Users\CMCDragonkai\Projects\js-virtualfs\node_modules\module-deps-sortable\index.js:396:17 at...

CMCDragonkai

File-level comments misapplied

1

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...

deg-basis

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 document a constant. My source...

deg-basis

not able to indetify the client system time format, either it is 12 hour or 24 hour time.

1

**If you're reporting a bug, please include _input code_, _output documentation_, a description of what you expected to happen, and what happened instead.** * What version of documentation.js are you...

rajuatuoh

Why is the position being removed from remark output

4

f4a46b134f58639f352b3024801c3d98f901d66a src/remark-remove-position.js Forgive me for putting this so bluntly, but…WHY? I was using documentation.js to parse documentation and extract code blocks for [ferrum.doctest](https://github.com/adobe/ferrum.doctest) and my build is failing because of...

koraa

Our implementation of doctrine library

2

I think we need to create new repository for doctrine with issues and pull requests. I prepare take a doctrine version 1.5 (it is important because version 1.5 contains a...

anthony-redFox

Add support for TSDoc-like @example syntax

1

[API Extractor](https://api-extractor.com/), which is based upon [TSDoc](https://github.com/Microsoft/tsdoc), has implemented support for the `@example` annotation, but it only supports markdown-like syntax as follows: ```js /** * Tracks acceleration and rotation rate...

kripod

This never works: ```javascript /** * Lorem ipsum * @hideconstructor */ export class EventDispatcher { constructor(initializer, finalizer) {} } ``` This doesn't work when using `--document-exported`: ```javascript /** * Lorem...

snoack

Documenting the export of a namespace doesn't appear to be working. In this case we want to specifically document an external object without documenting its internals. Example: ``` /** *...

goatonabicycle

Support export namespace

3

Support namespace exports in `--document-exported` ```js export * as Something from './file' ```

goodmind