Generate documentation of several VI's

Hi everybody, I'm attempting to generate automatically the documentation of my own VI's (connector, front panel and description)
I know that now Labview can execute a lot of things but that one particularly ???
Thanks
Solved!
Go to Solution.

thank you for your quick answer ! I didn't know this palette and its features.One subsidiary question
in my directory: I have my lvlib and my vi's how can I pass the path to the vi in charge of generating my documentaion.
In case of adding vi's what happened ?
thanks

Similar Messages

How to generate row numbering over several pages in PAGES??

How can I generate row numbering over several pages in PAGES??
e.g. Page1 1-35
Page2 36-...

Hi Labrat,
My suggestion would be to create a Template in the Page Layout mode. This template would have a 1-column Table to present the line numbers and a Text Box for the Body Text. If you want the Line Numbers to stay in alignment with the Body Text, set the spacing for both to Exactly. Set the Table Cell Borders to None. The faint cell borders that you see in the following example are there because I am in View Layout mode. They will not show when printed.
For my example I have used Format > Advanced > Capture Pages to create a Pull-down +Page option for a Numbered Line Page. You can Capture as many versions of your numbered pages as you like to avoid having to modify the Line Numbers on successive pages.
Here's my example:
Regards,
Jerry
Message was edited by: Jerrold Green1

Is there a way to automate generating the documentation from a function panel?

We have some DLL projects which contain function panel (.fp) files. We link a help file to the DLL so that we can call up the help file when using TestStand. As part of the build, we have to manually run Options -> Generate Documentation -> HTML. Then we load the .hhp file into the Microsoft tool HTML Help Workshop and select File -> Compile to generate a .chm file. Then in LabWindows/CVI we can build our DLL with links to the .chm help file.
Has anyone been able to automate this? It seems like it would be convenient to generate the help file in the Pre-build actions section of the Build Steps for the project.
Note: this slightly more convoluted process of generating the .chm file replaces the old method of generating a .hlp file from within LabWindows/CVI.
Solved!
Go to Solution.

Thanks, Luis. After generating the ActiveX interface to the CVI server, I was able to write a small command line program that calls GenHtmlHelpFromFPFile.
To generate the .chm file from the .hhp file, there's an executable provided by the HTML Help Workshop (hhc.exe). It only seems to work if you run it from the HTML Help Workshop directory, though. We have the following Build Steps:
cd "C:\Program Files\HTML Help Workshop"
hhc.exe %CVIPROJDIR%\name_of_fp_file.fp

Print VI Documentation always generates extra pages that are blank/empty.

I am using the Print ->VI Documentation to generate a document that contains my block diagram. However, I notice in the preview (and in the final printout) that there are always extra pages at the end. My block diagram takes up about 40 to 50 pages, and there are always anywhere from 10 to 40 extra blank pages generated.
My guess is that the blank pages are being generated because my block diagram has a width to height ratio that does not correspond to the width to height ratio of a letter sized page. Is this the reason? Is there any way around this other than to reorganize my block diagram to have a ratio of 8.5/11?
S G
Certified LabVIEW Architect, Certified TestStand Developer, Certified Professional Instructor

The only 3 options that I have selected are Block Diagram, Hidden Frames & Front Panel. My block diagram uses a state machine and has about 50 different states (cases). About half of these show up in the print. The remaining don't show up even though the number of pages in my print preview seems to be right.
S G
Certified LabVIEW Architect, Certified TestStand Developer, Certified Professional Instructor

Question about the Documentation Tags for Source Code

Hello,
I have a question about CVI's automatic source code documentation. My problem is that is seems like you need to write all documentation for a specific tag on one line. If you don't, a line break will be inserted when the documentation is displayed. Suppose I want to write a large amount of documentation for the function itself, using the HIFN tag. If I don't want linebreaks to be forced in the documentation, I need to write all this documentation on one single line, which kinda messes up my code. If I split the documentation over several HIFN tags, the documentation displayed to the user might look messed up because of all the linebreaks. Is there any escape character I can put at the end of a line, allowing me to split the documentation of several HIFN lines without forcing linebreaks in the documentation?
Thanks!
GEMIDIS - Innovating Display Technology
HQ Ghent, Belgium

This information is certainly useful. Note, however, that it can also be found in the documentation
Tag
Description
/// HIFN help text
Specifies the help text for the function. Use multiple /// HIFN tags to display help text for the function on separate lines. To separate help text with an empty line, use /// HIFN on a line by itself. You also can use HTML tags, but you must enclose the tags in <HTML><BODY></BODY></HTML> tags.
Example
/// HIFN SampleFunction returns the value of a control.
int SampleFunction (int controlID, ctrlType controlType, char label[], double *value)
SomeAction;

Best approach to dealing with someone else's sphagetti code with no documentation

Hello LabVIEW gurus,
I am just given a few software tools to add functionality and rewrite, each of which is a big spaghetti mess and each tool has 100+ vis all sphagetti, these tools control a very complex machine talking via seria, parallel, ethernet, 485 etc. and there is barely any documentation of the logic or the implemetation of the source code / what the subvis do.
what would be my best approach to understand this mess and recreate it in a structured way faster. it has lot of old sequence structures and just plain bad style of programming.
any help is highly appreciated
Thanks all

And Do not forget about using the VI Analyzer TK! It can reveal several obvious sources to clarify code that "Stinks" A lot of skull sweat went into that framework and it has signifigant value!
Norbert_B wrote:
If your task is only to ADD things, you might be interested in Steve's recommendation here.
Norbert
(Inside joke ahead)
Ah, That explains the TDMS File Viewer!
Spoiler (Highlight to read)
You really should run that through the VIA....:smileymad
You really should run that through the VIA....:smileymad
Spoiler (Highlight to read)
It can be done fairly quick
It can be done fairly quick
Spoiler (Highlight to read)
How do you unspoiler? Ah well I'll hope a moderator can leave only the first comment "spoiled"
How do you unspoiler? Ah well I'll hope a moderator can leave only the first comment "spoiled"
Spoiler (Highlight to read)
Note the quote from the link "The Code we inherited might have been "richly obfuscated."" "richly Obfuscaed code was a code review term used for code written by your boss... The VIA would call it something else.
Note the quote from the link "The Code we inherited might have been "richly obfuscated."" "richly Obfuscaed code was a code review term used for code written by your boss... The VIA would call it something else.
Jeff

Where can I get detailed documentation on the 'IVA' vision vi's created by NI Vision Assistant

I use the NI Vision Assistant a lot. Usually I ask it to create a vi automatically from the script. However, the resulting vi contains several 'IVA' vi's that are completely undocumented (from what I can see).
Where can I get more info on these? Examples of these are IVA Grayfilters - Nth order.vi and IVA Store Particles Results.vi (two of many such vi's) . They look like very useful and interesting functions but what exactly they do I can only guess.
Any ideas where I can get information on these functions.

I really appreciate your offer to help, however, it would probably be better for me in the long run if I could get this info from the official help on these functions?
But as an example, currently I am wondering what does IVA store particle results.vi do? It is called after IMAQ particle analysis.vi but just seems to be wasting precious processor resources. When do I need to include this (as is done by default by vision assistant) and when can I cut it out? It must have some purpose but who knows what this might be?
Thanks.

I installed VISA-RTE and there is only a documentation link in c:\programs\...

I just installed visa-rte on my XP PC. There is only a documentation link when I try to run the program (start, all programs, national instuments, visa). I was expecting a .exe. Is this normal or was there an install problem. Do I need Labview to get anything out of visa-rte? I am try to establish communication between a PC and several DC rectifiers. The rectifier manufacturer pushes VISA-rte and "Power Ten GUI". The "power ten gui" displays some canned screens but I dont see how the VISa-rte enters into it. Please help.

A runtime engine isn't always an executable. Sometimes it's just libraries. Did you also install Measurement and Automation Explorer when installing VISA? That should have created a blue icon on your desktop.
What is "Power Ten GUI"? Is it a LabVIEW app? If so, it's probably using VISA, which is why it requires the VISA runtime.

Documentation of Labview Vis

When distributing application programs created in Labview we have to provide a complete documentation package.
We used to print most of the Vis on paper which is very time consuming and pretty hard to maintain in case of a software upgrade.
I am looking for a tool to view the Labview source just like the development system but the user can not change or run the code.
I found the Labview player which looks like to have this functionality.
Is Labiew player for Labview7.1 available?
Has anybody some idea how to handle this in an easy way?

I'm looking for a package or library to document VIs of an application in a manner like the LV Help. This could be a HTML Help (chm-file) or a website (html-files).
I know that I can programmatically print to HTML with settings from application: printing and vi: printing. This will give a single HTML file for each VI - I don't like the appended version - with all the graphics files. This file isn't formated in any way so any postprocessing must be done; like referencing to a css, active links to callers and callees. For the windows platform compiling to chm with the HTML Help workshop would be nice, using the folder structure for the structure of the TOC.
I tried to find out what the nirsc_html_help_common package available from OpenG does but the description seems to be really empty. I tried to install it but didn't get it to work. This is another thing I have to solve.
I was pointed to the Documentation Generator from VI Engineering. This one seem to be either over featured or too expensive.
The online help is refering to third party products but I need something to create just the input for the HTML Help Workshop.
Can someone give me any hints about that?
Message Edited by waldemar.hersacher on 10-21-2008 02:18 PM
Waldemar
Using 7.1.1, 8.5.1, 8.6.1, 2009 on XP and RT
Don't forget to give Kudos to good answers and/or questions

Documentation tags and static functions

I'm an issue with the documentation tags. It appears that if the function is declared as a static function, it won't show up in the generated documentation (I'm using HTML). For example:
static int ArrayLocation(int i1, int i2, int num_coeff)
Will not show up, but if I remove the 'static' keyword then the function will show up in the generated documentation, i.e.:
int ArrayLocation(int i1, int i2, int num_coeff)
Thanks for any help with this.

Hi Wolfgang,
here I send you the documentation of the three functions:
correlate: http://zone.ni.com/reference/en-XX/help/370051P-01/cvi/libref/cvicorrelate/
correlateEx: http://zone.ni.com/reference/en-XX/help/370051T-01/cvi/libref/cvicorrelateex/
normalizedCorrelate: http://zone.ni.com/reference/en-XX/help/370051T-01/cvi/libref/cvinormalizedcorrelate/
I hope this helps you.
Best regards
Suse
Certified LabVIEW Developer (CLD)

OfficeJet 6500 model 709a: General printer documentation error 0x610000f6

Using Windows 7 Home Premium
I've gone through the recommended fix-it protocol several times (remove power cord, remove ink cartridges, remove feed from computer) but am unable to resolve this error message. One of the cartridges was reported as defective: I replaced it.
The message started after I'd disconnected the printer from my computer (USB connection); it did not resolve when reconnected to the computer.
Can you help?
Spoiler (Highlight to read)

Hi,
This error code refers to a carriage jam issue.
Please follow the steps in the link given below and check if it helps you
http://h10025.www1.hp.com/ewfrf/wc/document?docname=c01658090&tmp_task=solveCategory&cc=us&dlc=en&ju...
Thanks.
I work for HP.

Documentation of the *.daq-File in MAX

Is there any possibility to generate documentation of the current MAX-configuration?
Or can I export the current MAX-configuration to any file-format, eg a txt-File?
Thanks.
Test Engineering
digades GmbH
www.digades.com

Hello;
I don't know exactly what you need to achieve on your application, but, at this point, there is no way to read the .daq files or convert that type of files to any txt file format. What you can do is to have Labview changing the config file for you.
I'm attaching a LV example VI which does that, just in case you need it.
Hope this helps.
Filipe
Attachments:
Change_NI-DAQ_Config_File.zip ‏18 KB

Documentation for modelsupprt2.dll

Hi,
I need to modify parallel execution model. Where do I find documentation modelsupport2.dll?
thanks
CT

Comteker,
Having done substantial modifications to the Modelsupport2.dll in the past (circa TestStand v2), I have not run across any documentation on this module, other than the comments in the C source code itself. If they've generated any since then, I haven't run across it. I don't believe it's changed much since TestStand v2, other than to update the TestStand API calls to the more robust function set, and removing deprecated functions. The bad news is that NI doesn't document the source they provide all that well (no version history, or function descriptions w/ interface info), but the documentation of the API calls used in this DLL are fairly well documented.
If you're trying to figure out how it works, my suggestion is to generate a debuggable version of the DLL, and run simulations, tracing into the dll at the points you're trying to understand better.
Hope this helps.
-Jack

How can I include multiple limits in the sequence file documentation for custom step type?

Hi,
I have a custom Step Type that contains Measurements property under Results. Its type is Array of NI_LimitMeasurement.
I would like to see the values in the sequence file documentation like NI_MultipleNumericLimitTest type.
Is there any trick to do that?
Thanks,
Andras

Hi Andras,
I have made a slight change to the sequencefile 'docgen_txt.seq'.
In the Sequence 'Step Doc' is a section which handles MultipleNumericLimit step type. There is a precondition check on the step 'Add Multiple Numeric Limits' if the step is of type 'NI_MultipleNumericLimit'. As your step type is based on the MultipleNumeric Limit type, I have just removed this precondition and just relied on the existence of Parameters.Step.Result.Measurement. Equally you could add a new section in this sequence to handle your Custom Step Type which is only called when the precodition match your type name.
Now when you run the DocGen tool it handles your custom step type.
Find attached my modified sequencefile 'docgen_txt.seq'.
Just copy the contents of '..\National Instruments\TestStand 3.5\Components\NI\Tools\DocGen' to the User folder. Then place the attached file in the User\Tools\DocGen overwritting the version that is in that folder.
Then launch TestStand and try it out on your sequence file.
If you are using the html version, then you will have to make the same change into Step Doc sequence of the docgen_html sequence file.
Hope this helps
Regards
Ray Farmer
Message Edited by Ray Farmer on 05-19-2007 05:28 PM
Regards
Ray Farmer
Attachments:
docgen_txt.seq ‏184 KB

My 5180 wont print on board screen says print cartridges refer to documentation

my 5180 won't print,on board screen,icon and says printer cartridges-refer to printer documentation.I did no help.I believe ink levels are good.

Hi alleypoo,
I would like to help you with the ink error you are seeing on the printer screen. Please use the following documents to troubleshoot the issue. 'Ink cartridge is missing, incorrectly installed, or not intended for your device' Message Displays ....
You may also try the follow steps to override the message.
Disconnect any cables (Ethernet cable or USB cable) that connect both the printer and the computer.
Restart your computer. (Consider bookmarking this page in your Web browser so that you can easily return to it after the computer restarts.)
With the printer turned on, remove the power cord from the back of the printer.
Wait 30 seconds.
Insert the power cord back into the printer, and turn the printer on.
Clear any error messages.
Reconnect any cables that connect the printer to the computer.
If the issue persist, call HP. They may be able to offer you a discount on a newer model. The number to call HP is 1-800-474-6836 for Canada and US, or you can Contact HP Worldwide.
I hope this helps.
Please click the Thumbs up icon below to thank me for responding.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Please click “Accept as Solution” if you feel my post solved your issue, it will help others find the solution.
Sunshyn2005 - I work on behalf of HP

Generate documentat​ion of several VI's

Similar Messages

Maybe you are looking for

Generate documentation of several VI's