BlueBird v0.3.4 BlueBird.Writer.Blueprint

Defines functions to generate an API BluePrint representation of the BlueBird.ApiDoc struct.

Link to this section Summary

Functions

Generates a string from an BlueBird.ApiDocs{} struct

Writes a BlueBird.ApiDoc{} struct to file

Link to this section Functions

Link to this function generate_output(api_docs)
generate_output(BlueBird.ApiDoc.t) :: String.t

Generates a string from an BlueBird.ApiDocs{} struct.

Link to this function run(api_docs)
run(BlueBird.ApiDoc.t) :: :ok | {:error, File.posix}

Writes a BlueBird.ApiDoc{} struct to file.

This function will be called automatically by BlueBird.Formatter after every test run.

You can set the destination directory in config.exs.

config :blue_bird,
  docs_path: "priv/static/docs"