hipar

[john_cvi_user]

/// HIPAR (parameter)/text descripton not displaying on tooltip

///HIRET and HIFN Display ok

[Constantin--P]

Hello John,

You need to provide more details.

• What CVI version do you use
• What's the function prototype?
• How documentation  tags look like?

Constantin

[john_cvi_user]

using: cvi2103 sp1

note the empty description field in the html output there is also no detail on the tooltip for parameters.

I have also tried the ///OUT but with no success.

code:

/// HIFN    Ini_Read_File
/// HIFN NOTE: Loads configuration data from the .ini file
/// HIRET (integer) sucsessful read of configuration, negative value indicates failure
/// HIPAR *iniSection number of sections in the ini file which are read.
int Ini_Read_File(int *iniSection)
{

html output:

Ini_Read_File

int Ini_Read_File (int *iniSection);

Purpose

Ini_Read_File
NOTE: Loads configuration data from the .ini file

Parameters

Input
Name	Type	Description
iniSection	int *

Return Value

Name	Type	Description
returnValue	int	(integer) sucsessful read of configuration, negative value indicates failure

References

[RobertoBozzolo]

Can you try with:

/// HIPAR iniSection/Number of sections in the ini file which are read.

/// OUT iniSection

and see how the output looks like? Note the slash betwee the parameter name and its description.

[Constantin--P]

Hello John

The syntax for HIPAR is

/// HIPAR paramName/help text

 In you case it should be

/// HIPAR iniSection/number of sections in the ini file which are read.  

 Hint: You can put the cursor inside the function and Edit>Insert Construct>Function Documentation Tags (Ctrl+Shift+G). This adds automatically the necessary tags.

Constantin

[john_cvi_user]

Thanks for responses:

Using

/// HIPAR iniSection/number of sections in the ini file which are read. 

now displays on the html file in the debug folder

Note: do not use * when declaring pointer parameters and use forward slash with no spaces between parameter and description text

However the parameters still not apperaing on the tool tip. I have tried various combinations of /// HPAR and /// OUT

[Constantin--P]

Hello John,

The parameter is shown in the tooltip when the cursor is on the parameter position(inside parentheses) and not on the function name.

Constantin

[john_cvi_user]

Many Thanks

So easy once explained, wish i had known how to use this feature earlier.

John