Documentation Options

You can click Tools > Documentation to generate HTML documentation for the projects and related files you select. In the Documentation dialog box that's displayed, you can specify the following options:

Output Folder Browse to or enter the path to the folder where you want to output the documentation. If you enter a relative path, the documentation is output under the "data" folder in the Flow Designer's USER_DIR folder, C:\Users\[Windows username]\AppData\Roaming\Asteria\ASTERIA Warp Flow Designer\[version]\data.
Title Enter the title of the document. This is the title of the index page and the value of the document's <title> tag in the HTML.
Target Files In the tree, select projects, function collections, external variable sets, stream definition sets, or a folder that contains these files.
Options
Include references Select this option to output additional information listing the source components that reference the child flow, SubFunction, or variable is referenced.
Include statistics page Output a statistics page that includes the following:
  • The total number of components and mapper functions in each flow
  • Totals for each type of component and mapper function.
Include a printable page Output an additional page containing the documentation as a single HTML document.
Include update history Output update history from the SVN log. You need to enable version control for the user you're logged in as.