documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Empty documentation if file is all exports

Open goodmind opened this issue 6 years ago • 4 comments

Input code

export {combine} from './combine'
export {sample} from './sample'

export type {Domain} from 'effector/domain'
export {createDomain} from 'effector/domain'

export type {Event} from 'effector/event'
export {
  createEvent,
  forward,
  fromObservable,
  chord,
  filter,
} from 'effector/event'

export type {Effect} from 'effector/effect'
export {createEffect} from 'effector/effect'

export type {Store} from 'effector/store'
export {
  createStore,
  createStoreObject,
  setStoreName,
  extract,
  createApi,
  restore,
  restoreEvent,
  restoreEffect,
  restoreObject,
  withProps,
} from 'effector/store'

export {Kind, clearNode, createGraph as createNode, step} from 'effector/stdlib'
export {launch} from 'effector/kernel'
export type {kind} from 'effector/stdlib'

export {
  invariant,
  warning,
  isUnit,
  isStore,
  isEvent,
  isEffect,
  isDomain,
  is,
} from 'effector/validate'
export {version} from 'effector/flags'

//eslint-disable-next-line
export * as blocks from 'effector/blocks'

Output docs

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents
  • What version of documentation.js are you using?: 10.1.0
  • How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):CLI

goodmind avatar Apr 26 '19 03:04 goodmind

Does this project have any JSDoc annotations, or /** comments at least? Perusing the project, it doesn't look like it has any documentation markup.

tmcw avatar Apr 26 '19 03:04 tmcw

Shouldn't it generate something at least from types?

goodmind avatar Apr 26 '19 05:04 goodmind

I tried --document-exported but it doesn't resolve babel-plugin-module-resolver aliases

Full command

yarn documentation build --babel=./babel.config.js src/effector/index.js -f md -o api_docs --document-exported

goodmind avatar Apr 26 '19 08:04 goodmind

@tmcw any advice?

goodmind avatar May 04 '19 14:05 goodmind