Link between documentation tags and FPs

[gdargaud]

Hello all,

When crating a function panel, I remember that there's some way to partially populate it automatically based on the documentation tags (HIFN, HIPAR...) but I can't seem to find the way to do it. Or is it the other way around, creating function prototypes and documentation tags from a newly created FP ?!?

Thanks

[Constantin--P]

If you open a header file that contains documentation tags Options>>Generate Function Tree is what you need.

You can also have a look on this tutorial about documentation tags

[gdargaud]

Hmmm, that's what I'd tried and the link you provide at least gave me a working example. When used on a DLL header, it's really picky as to what it will covert to a FP. For instance:

export int DLLEXPORT fn1(int a);

// Unknown data type error

DLLEXPORT export int fn2(int a);

// fails silently

export DLLEXPORT int fn3(int a);

// Unknown data type error

DLLEXPORT int fn4(int a);

// Fails silently

int DLLEXPORT fn5(int a);

// Success at long last !!!

I'd file this as a bug report...

[gdargaud]

Also the syntax is actually quite different from the documentation tags: HIFN, HIPAR, HIRET etc become HFUN, HPAR and many more. Is there a reason for that ? Maybe the former are supposed to be used in the.c file and the latter in the .h, but then it's double the work to document your code !

[Andr3s_Br3n3s]

Hi 

Did you mention this: http://www.ni.com/tutorial/6502/en/ Using Source Code Tags to Enhance LabWindows™/CVI™ Code Documentation  ?

[gdargaud]

Absolutely. Why two sets of tags for what will eventually be the same comments ?

[Andr3s_Br3n3s]

In the documentation it says: The following tags might appear similar to the tags you use to generate a function panel from a .h file. However, you can use the following tags only in .c files for the purpose of adding information that appears in tooltips. You can use header file tags only in .h files for the purpose of defining a function tree structure.

[gdargaud]

And yet, using the following in your header file DOES work in creating a FP (note the use of parameter position instead of parameter name...):

/// HIFN	Add two numbers
/// HIPAR	1/First number to add
/// HIPAR	2/2nd number to add
/// HIRET	Sum of a and b
int DLLEXPORT Cmpt_AddI(int a, int b);