Flow docs

[montogeek]

Hi!

This is the HTML generate by the following code:

// @flow
type FlightParams = {
  airline: string;
};

type Flight = {
  display: string
}

const Fligths = {
  /**
   * Test
   */
  getFlights: (data: FlightParams): Promise<Flight[]> => {
    return client.get(GET_FLIGHTS_ENDPOINT, { query: data })
      .then((response): Array<Flight> => {
        return response.flights.map((flight): Flight => {
          return {
            display: flight.label
          }
        });
      })
  }
}

export default Fligths;

Shouldn't it create docs for the params and return values?
I am using documentation 4.0.0-beta9

Thanks!

[arv]

Try using --document-exported.

There is still more work to do when it comes to outputting the types nicely.

[montogeek]

Same output

[montogeek]

Oh, is on beta10

[arv]

Hmmm... I guess the changes are not in the latest beta release. Try using master instead.

[montogeek]

I am a beta behind, updating...

[montogeek]

Still, same output

[montogeek]

When using master, all static methods were deleted from the output

[arv]

I have to look at it. --document-exported is a new feature and it is possible/likely I forgot some cases.

[arv]

I figured it out. I'm currently not handling var x = function () {} or var x = { ... } in the --document-exported case. I'll get a PR up but it will depend on some open PRs because they all touch the same area.

[montogeek]

No worries!
Thanks!!

[montogeek]

@arv I am getting the same behaviour using beta12.

My project is composed by modules that exports an object with methods:
foo.js

// @flow
const Foo = {
 /**
  * Desc
  */
  method: (params: <T>): Promise<T> => {};
}
export default Foo;

import foo from './path/foo.js'

export default {
 foo
}

I get a empty HTML output, without params and return values using --document-exported.
I get a nice output with all methods grouped by its module without using --document-exported.

[arv]

I finally got to look at this...

The problem is the export default ___ only handles declarations and identifier expressions. https://github.com/documentationjs/documentation/blob/master/lib/extractors/exported.js#L69-L77

If you write:

export default 42;

as:

const temp = 42;
export default temp;

...we do generate documentation for it.

[arv]

@montogeek Can you try with master to see if this works sufficiently for you? Thanks.

[montogeek]

@arv With master, I get the same results as the original code: #543 (comment)

[montogeek]

Thanks for working on it!

I can keep writing JSDocs manually :)

[arv]

@montogeek I'm not sure where we are with this? Can you provide an example input and an expected outut? #623 did add tests for what I thought was missing. Thanks.

[carocad]

@arv I think I am having the same problem as @montogeek. Here is a bit more context:

/**
 * This function adds one to its input.
 */
var foo = {
  /** bar member */
  bar: function addOne(input: number): number {
    return input + 1;
  }
}

the previous input with renders as:

On the other hand, if I write it like this:

/**
 * This function adds one to its input.
 */
var foo = {}

/** bar member */
foo.bar = function addOne(input: number): number {
  return input + 1;
}

then the output is:

Both cases are definitely equivalent but documentationjs seems to not support flow type annotations on static methods.

I hope this helps :)

[arv]

@carocad I think this is fixed in 4.0.0-rc-0. I'm getting identical results for those two cases:

[arv]

Ignore the new, it is because I named the function expression AAAand BBB respectively.

[carocad]

@arv I can confirm that with the version 4.0.0-rc.0 the types are outputted to the documentation as well :)

PS: You had a typo in the version 4.0.0-rc-0 it should be 4.0.0-rc.0 just in case somebody else wants to test it ;)

[arv]

Closing. Feel free to open a new issue if you see something else.