LabWindows/CVI

cancel
Showing results for 
Search instead for 
Did you mean: 

LW2017 - Documentation tags like HIFN and embedded HTML

In the help file for LabWindows 2017 is this comment about using documentation tags:

 

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.

 

I cannot figure out how to make the HTML tags work in the generated HTML help files -- though I do see them added to the XML file.

 

I have tried putting those tags around specific things, and blocks of things, but nothing shows up. I had hoped this meant I could do something like this:

 

/// HIFN <HTML><BODY><PRE>typedef struct
/// HIFN {
/// HIFN uint8_t value1;
/// HIFN uint8_t value2;
/// HIFN uint8_t value3;
/// HIFN } SomeStruct;</PRE></BODY></HTML>

 

But in the generated output, it just shows the "<HTML>etc." characters along with the text in between them.

 

Anyone know how to make this work?

0 Kudos
Message 1 of 1
(433 Views)