No support for exported flow types

[trodrigues]

When splitting and reusing types between multiple modules, it's common to use Flow's export type syntax.

This doesn't seem to be actually documented but it's explained in this blog post: http://flowtype.org/blog/2015/02/18/Import-Types.html

Right now, documentation.js seems to only infer the name from these kinds of declarations. So if you have something like:

/**
 * Define my object API
 */
export type SomeObjectAPI = {
  method: (param: string) => boolean
}

the generated documentation only shows something like:

SomeObjectAPI
Define my object API

However, if I were to do something like

/**
 * Define my object API
 */
type SomeObject = {
  method: (param: string) => boolean
}
export type SomeObjectAPI = SomeObject

it would work fine.

[ajhyndman]

It seems to me like this is a more general issue, in fact.

Using the export keyword inline with a documented feature, seems to cause a failure in documentation.js's parser. Signature information for that code feature appears to get garbled.

I set up a small demo demonstrating this:
ajhyndman/documentation-js-demo@6dee0bd

[tmcw]

Thanks for the testcase @ajhyndman. Going to look into a cause for this.

[tmcw]

Okay, so in the case of:

/**
 * Return a number multiplied by two.
 * @memberof main
 * @param a A number to be doubled
 * @returns The input number, doubled
 */
function double (a: number): number {
  // Do some stuff
  return a * 2;
}

This is that right now we intelligently let you specify @param in the document tag and then 'enhance' it by adding flow-inferred typing to it. We don't do the same thing with @returns - if you specify the documentation tag, we don't try to infer its type. We should.

That said, this is a different issue than the OP, since this happens on the code irregardless of the exports keyword.

[tmcw]

In current master/beta15, this bug persists: the output for the given example is

# SomeObjectAPI

Define my object API

Will have to look into this: I think the issue is that the template doesn't output the type of typedefs.