Auto-copy all free-label text on root of diagram to VI documentaion.

[LAVA 1.0 Content]

Very often I find myself copying the documentation I put on the root of the BD (the white background, not inside structures) and pasting it as VI documentaion.

It seems that I could save a lot of time if these comments automatically appered in the VI documentation.

Thoughts;

If there is already text in the VI documentation, then the new free-label text would be added to the end of what is already there, possibly with a header saying "Comments for Block Diagram follow:"

If the there is more than one free label they would be seperated by two CRs to make them easier to read.

If you don't want it to do this automatically, then how about a button on the VI dialog screen that when clicked copies the text?

Another variation would be to add a right-click option to free-lables that woudl copy THAT text to the VI docuemtation?

For LVOOP accessor VIs I'd like to it to add documentaion that reads "Get Y where Z" such that Y= the data element being accessed and Z= documentaion for that value as defined in the class data definition.

Your thoughts and opinions on this idea are welcome.

If y'all think this will save you time, chime in and I'll submit the product suggestion.

Take care,

Ben

[Chris Davis]

This can be done now, using scripting. I'm using a VIPM 2 pre build VI to check the format and presense of VI properties text, as well as block diagram and front panel free label text. Using the private save instrument invoke node would allow you to save the results of an automatic copy/paste routine.

I had thought about using this type of technique in conjunction with other code documentation techniques to provide a way to parse a directory of code for "developer's manual" entries to be able to produce an automatic developer's manual on a project.

[Louis Manfredi]

QUOTE (neB @ Oct 1 2008, 10:49 AM)

Another variation would be to add a right-click option to free-lables that woudl copy THAT text to the VI docuemtation?

Hi Ben:

I'd vote in favor of the Right-Click on Label option... I think that's and excellend idea which would be a time saver & encourage better vi documentation.

I'm not hot about any wholesale copying of free labels to documentation-- too many of my free labels are labels for adjacent shift registers, notes over wires, notes to myself about things to fix or hooks for future features, and the like. If all that stuff ended up in the VI documentation, it would be counterproductive.

Best, Louis

[LAVA 1.0 Content]

QUOTE (Louis Manfredi @ Oct 1 2008, 11:22 AM)

Hi Ben:

I'd vote in favor of the Right-Click on Label option... I think that's and excellend idea which would be a time saver & encourage better vi documentation.

I'm not hot about any wholesale copying of free labels to documentation-- too many of my free labels are labels for adjacent shift registers, notes over wires, notes to myself about things to fix or hooks for future features, and the like. If all that stuff ended up in the VI documentation, it would be counterproductive.

Best, Louis

I should add to my previous...

I am not stuck on any of those ideas and methods. I just want to make the documentaion work easier and if Y'all have better/different ideas, please share them.

Ben

[LAVA 1.0 Content]

QUOTE (Louis Manfredi @ Oct 1 2008, 11:22 AM)

Hi Ben:

I'd vote in favor of the Right-Click on Label option... I think that's and excellend idea which would be a time saver & encourage better vi documentation.

I'm not hot about any wholesale copying of free labels to documentation-- too many of my free labels are labels for adjacent shift registers, notes over wires, notes to myself about things to fix or hooks for future features, and the like. If all that stuff ended up in the VI documentation, it would be counterproductive.

Best, Louis

The right-click on Label option sound a good idea.

Another argument against the auto-copy of all free-label would be for VI with state machine, events structure or some similar design pattern. This could generate a lot of free-label base on the number of state.

Another idea. Using a tag may be interesting to decide which part of the free-label you want to display

http://lavag.org/old_files/monthly_10_2008/post-6703-1222957706.gif' target="_blank">

[Yair]

Using scripting, you can also add a VI to the Tools menu which will get the Selection List[] property for the current VI, check each element to see if it's a comment, and if it is, add its text to the VI's description. The Comment class does not have an exposed Text property, so you can type cast it to the String class.

Of course, you can also do this as a floating tool which will be open all the time. If you want to save time on some of code, you can lift code from the CCT or the tunnel wiring wizard.