Project Documentation Tool

[dsavir]

Hi,

Based on jareds' code, here is the project documentation tool.  It creates an html file that mimics the directory structure of your project: One page for the project itself, and links to other pages for each folder or library. It shows the name, connector pane and description for every VI, and the description of every library, class, and the project. In addition, for every VI it adds a table showing that VI's bookmarks. I've found this very useful for top level documentation of my code for other programmers.

Instructions for use:

Unzip and copy it into your <LabVIEW>\project folder and it will show up in Tools menu as Generate Project Documentation.

LabVIEW version: 2014

Features:

- Creates documentation html files for all open projects.

- Every virtual folder/library has a link in the main page

- Documentation files saved in <project folder>\<project name> Documentation\Documentation.html

- Every VI as the connector pane, name and description

- Description of every library, class, and project

- Bookmarks of every VI

- Does not create documentation for the following project items: Packed libraries, dependencies, Folder named Documentation, files that aren't LabVIEW items (i.e. text files etc.)

Possible future features:

- has the beginning of using a word report instead of an html report, not done.

[Maud]

Hello, Thank you for your work. I must be missing a step, as I don't manage to make it work: I unzip your files in my project folder, I tried adding them to the project, but no matter what, I don't get anything new in Tools. Am I missing something obvious?

[UliB]

@Maud

Do not unzip to the project folder you want the documentation of, but unzip to <LabVIEW>\project folder, which might look like this 'C:\Program Files (x86)\National Instruments\LabVIEW 2015\project'. Then restart LabVIEW.