Documentation tag bug

[gdargaud]

Hello all,

just found a bug in CVI 2013 sp2.

I have a function with a variable number of args:

void Secure(const int MainPanel, ...) { ... }

I started typing above:

/// HIFN Whatever
/// HIPAR MainPanel / Something
/// HIPAR ... / Others
/// HIPAR ... / Some more

... And CVI crashed.  Twice.

[Gloorious_Leader]

Hi gdargaud,

I've been trying to reproduce the crash and have not been successful yet. Does the crash occur while you are typing the code or only at execution? Is there any addition code or is it only the 4 Source Code Tags and the function declaration?

[Johannes_T · Accepted solution]

Hello, gdargaud!

The crash you experienced is caused by the fact that CVI is unable to handle the incorrect usage of the HIPAR in conjunction with the "..." variadic parameter name string, when it tried to generate browsing information.

The problem is filed under bug ID #514226 and will be resolved in an upcoming version of CVI.

Meanwhile, the best workaround for this problem is one of the following:

1. Avoid using the incorrect construct /// HIPAR ... when trying to specify the documentation string for the variadic parameter, when browsing information generation is enabled in the CVI ADE.
2. Note, that disabling browsing information generation (Set Options » Environment » Source Code Browse Information » Generate browse information policy to Disabled) , when this incorrect construct is present in your code, will not cause CVI to crash.
3. As of CVI 2013, you can specify a documentation string for the variadic parameter, by using the HIPARV documentation tag. Check the Documentation Tags for Source Code topic in the LabWindows/CVI Help for more details on how to use this documentation tag or others.
   /// HIPAR param/Param documentation string.
   /// HIPARV Variadic argument documentation string.
   void func(int param, ...) { }

Best regards!

- Johannes

[gdargaud]

Kudo for reproducing the bug and thanks for the HIPARV, I didn't know that one.

[Johannes_T]

You are welcome, gdargaud! 😉