Skip to content

Support for ".js.flow” style workflow? #686

Open
@Happy-Ferret

Description

@Happy-Ferret

Curious.
Is there currently a way to get proper documentation from a ".js.flow" based project workflow, as documented here?

My personal library project is organised in the following manner:

  • Per function/class module files (puts.js in this specific case) with the following syntax:
/**
 * This is a function
 */
function puts(str) {
// do some stuff
}

module.exports = puts;
  • A main.js cumulating all the existing modules, exposing them as one
module.exports = {
    puts: require("./src/puts")
}
  • A main.js.flow declaring all the typings.
declare export function puts(str: string): void;

What I expect to see is something akin to

puts(str: string)
Parameters
str (string)

What documentation build main.js -f html -o docs actually produces is:

puts(str: any)
Parameters
str (any)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions