Generation of a glossary of functions used in a Labview project

[MAC_D]

Hello

I am writing a report which must include screen shots of every VI and sub VI in a labview project that i have created. I am looking for a way to generate a glossary of functions that were used in the project. I need this so people who are not familar with Labview can understand my code.

It this possible?

Thank you

MAC_D

Message Edited by MAC_D on 09-24-2008 03:50 AM

[smercurio_fc]

Have you taken a look at the documentation output that you get from File -> Print...? A fair amount of information can be printed from this.

[MAC_D]

Thanks for that smecurio_fc. It's a big help. priniting the file will show all the sub VIs and Express VIs used. Is there any way of generating a similar display of all the functions used? The readers of my report will have no experience in Labview so i want to expalin every function used, i.e +,- x, down at that level.

Kindest regards

MAC_D

[johnsold]

I can think of two things which may help.

1. Print the help pages for the function you need to describe.

2. Create a VI (similar to the  Tree VIs which come with many instrument drivers) which contains the functions and any description you add.  Then print that VI. This VI would not be functional, it would only be for documentation purposes.  You may need several VIs to keep the diagrams and printed results to a readable result.

Lynn

[smercurio_fc]

---

MAC_D wrote:

Thanks for that smecurio_fc. It's a big help. priniting the file will show all the sub VIs and Express VIs used. Is there any way of generating a similar display of all the functions used? The readers of my report will have no experience in Labview so i want to expalin every function used, i.e +,- x, down at that level.

---

I'm not sure I understand this. Are you referring to including the built-in functions like Add, Subtract, Build Array, and so on? If so, what would be the point? That's like asking a text-based coder to document pointer operation like "->". You should document the algorithm you used, not the language. The language has already been documented by NI.

[MAC_D]

Yes i want to document all the basic functions that i use. While i know that function like add and subtract are quite self explanatory, build arrary for example is not. I want people who are not familar with Labview to be able to have an idea what each VI is doing and what each function that i have used is.

[smercurio_fc]

Lynn's suggestion will not be able to go as far as giving you the documentation for Build Array, for example. Don't really know of a way to do that. Might be able to do that with scripting, but that's another story. 

<START PERSONAL COMMENT>

Speaking on a personal level, if someone gave me documentation that included all of that gory detail I would think they're just trying to "fluff up" the documentation. I see little point in documenting something that has already been documented quite extensively by NI, like I said. You can list the functions, but that's of little use since it doesn't document how you used them, now does it?

On a side-note, I think Build Array is quite self-explanatory, even if you don't know LabVIEW. And if you don't understand the basic terms "build" and "array", then you have no business reading the documentation or criticizing it in the first place. But that's just my opinion. 

<END PERSONAL COMMENT>