Jump to content


Photo
- - - - -

Question regarding documentation tools


  • Please log in to reply
9 replies to this topic

#1 Daklu

Daklu

    Bringing the Fu to you

  • Premium Member
  • 1,752 posts
  • Location:Seattle
  • Version:LabVIEW 2009
  • Since:2006

Posted 11 January 2012 - 09:48 PM

I'm digging deep in the dusty corners of my memory for this so I'm probably misunderremembering things, but...

Doesn't OpenG use block diagram comments with special tags to set the vi properties documentation? Are the tools for converting the comments to documentation available somewhere?

Certified LabVIEW Architect
Dak's First Law of Problem Solving: If the solution looks simple, I don't know enough about the problem.

Yes, the QSM is flexible. So is Jello. That doesn't make it good construction material.

There are two secrets to success:
Secret #1 - Never tell everything you know.


#2 jgcode

jgcode

    LabVIEW Renegade

  • OpenG
  • PipPipPipPipPipPip
  • 2,397 posts
  • Location:Australia
  • Version:LabVIEW 2009
  • Since:2005

Posted 11 January 2012 - 11:41 PM

Hi Dave

Someone might be able to reply with a better answer who worked on older releases as I was responsible for upgrading the sources to VIPM - I know there was scripts that updated labels with build information (I know as a wrote code to remove these artifacts) but AFAIK the license stuff and documentation was static.

Having said that it would be super easy to script code to find a label (which had e.g. a tag on it) and update the VI Properties Documentation or vice versa.



#3 Daklu

Daklu

    Bringing the Fu to you

  • Premium Member
  • 1,752 posts
  • Location:Seattle
  • Version:LabVIEW 2009
  • Since:2006

Posted 12 January 2012 - 12:16 AM

I know there was scripts that updated labels with build information...

Ahh... that's it. Thanks Jon.

I guess I'll fumble around with scripting once again. As for it being super easy, I suppose once you know how to do it it is, but until then it's mostly just a frustrating expedition of trial and error. (NI hasn't published any sort of object model for the scripting engine have they?)

Certified LabVIEW Architect
Dak's First Law of Problem Solving: If the solution looks simple, I don't know enough about the problem.

Yes, the QSM is flexible. So is Jello. That doesn't make it good construction material.

There are two secrets to success:
Secret #1 - Never tell everything you know.


#4 jgcode

jgcode

    LabVIEW Renegade

  • OpenG
  • PipPipPipPipPipPip
  • 2,397 posts
  • Location:Australia
  • Version:LabVIEW 2009
  • Since:2005

Posted 12 January 2012 - 12:56 AM

No probs.

(NI hasn't published any sort of object model for the scripting engine have they?)


Not that I know of - maybe you could script one? ;)

Right clicking a node and trawling through the menus is one of the things I do.

I am no scripting ninja, but if u get stuck on something just post or PM me - like anyone else on this forum - I am happy to help.

#5 Ton Plomp

Ton Plomp

    How many lines per hour? Zero!

  • Premium Member
  • 1,973 posts
  • Location:Netherlands
  • Version:LabVIEW 2012
  • Since:2000

Posted 12 January 2012 - 07:32 AM

I think that th OpenG sourcebase at sourceforge has the utilities you look for.
Most likely this folder.

Ton

#6 jcarmody

jcarmody

    The 500 club

  • Premium Member
  • 789 posts
  • Location:North Carolina, United State, Earth
  • Version:LabVIEW 2012
  • Since:2007

Posted 12 January 2012 - 10:55 AM

Here's how I found all Free Labels on all Block Diagrams below one top-level VI:

ReqHatch_BD.png

Then, I looped through them looking for the tag I was interested in:

ReqHatch_BD.png

Be careful while scripting, not because of the "rusty nails" but more because it could be more fun than what you're supposed to be working on...

A hairy yak is a happy yak ~ unknown, circa 2000 BC

Resistance is Mandatory

No rulers
No masters
NO CONSENT

 


#7 jgcode

jgcode

    LabVIEW Renegade

  • OpenG
  • PipPipPipPipPipPip
  • 2,397 posts
  • Location:Australia
  • Version:LabVIEW 2009
  • Since:2005

Posted 12 January 2012 - 02:16 PM

Be careful while scripting, not because of the "rusty nails" but more because it could be more fun than what you're supposed to be working on...


Damn straight! :lol:

#8 Daklu

Daklu

    Bringing the Fu to you

  • Premium Member
  • 1,752 posts
  • Location:Seattle
  • Version:LabVIEW 2009
  • Since:2006

Posted 12 January 2012 - 04:54 PM

Thanks for the link Ton. I'm definitely going to spend a bit of time looking over those.

I think 2009 was the latest version I've tried scripting with. The traverse vi shown in Jim's post wasn't available as far as I know, but boy it sure makes scripting easier. I still have to create a scratch vi to figure out the name of the object I'm looking for, but the whole process is much easier than it used to be. Now I just need to spend some time figuring out the available documentation tools and seeing if I can simplify my process.

Certified LabVIEW Architect
Dak's First Law of Problem Solving: If the solution looks simple, I don't know enough about the problem.

Yes, the QSM is flexible. So is Jello. That doesn't make it good construction material.

There are two secrets to success:
Secret #1 - Never tell everything you know.


#9 ShaunR

ShaunR

    LabVIEW Archetype

  • Members
  • PipPipPipPipPipPip
  • 2,224 posts
  • Version:LabVIEW 2009
  • Since:1994

Posted 12 January 2012 - 05:04 PM

*
POPULAR

Thanks for the link Ton. I'm definitely going to spend a bit of time looking over those.

I think 2009 was the latest version I've tried scripting with. The traverse vi shown in Jim's post wasn't available as far as I know, but boy it sure makes scripting easier. I still have to create a scratch vi to figure out the name of the object I'm looking for, but the whole process is much easier than it used to be. Now I just need to spend some time figuring out the available documentation tools and seeing if I can simplify my process.

It is available in 2009. It just isn't in any of the palettes (it's in vi.lib/utility/traverseref.llb).
A positive attitude may not solve all your problems, but it will annoy enough people to make it worth the effort. (Herm Albright 1876-1944).

Founder and general mischief maker on www.labview-tools.com.
SQlite aficionado and websocket zealot.
If it 'aint in LabVIEW, then you 'aint got a clue!

#10 jgcode

jgcode

    LabVIEW Renegade

  • OpenG
  • PipPipPipPipPipPip
  • 2,397 posts
  • Location:Australia
  • Version:LabVIEW 2009
  • Since:2005

Posted 12 January 2012 - 09:38 PM

For anyone else interested ->

I downloaded the tarball in Ton's link and created a wrapper VI for the action of interested.
If you run Main in the same folder as OpenG.vit and the extracted tarball folder than it will update the OpenG Tags on the FP.

tags.png

Attached File  Main.vi   12.12K   50 downloads
Attached File  OpenG.vit   4.04K   45 downloads
Attached File  opengtoolkit-build support.tar.gz   1.58MB   49 downloads

All files in LabVIEW 2009.

script.png