Documentation Tags Multiple Lines and Output Style

[kevin.key]

Can you make the documentation tags text span multiple lines. For instance the /// HIFN tag, sometimes to fully describe things it can take a lot of words so it would be nice to be able to do that.

Also, what do you have to do to generate help outputs with the style that seems pretty standard for the libraries that come with CVI?

[RobertoBozzolo]

Documentation tags can span on multiple lines provided they start with the same keyword. Just to make an example:

/// HIFN MyFunction()
/// HIFN Function description to be displayed in help screen
/// HIFN Third line of description
/// HIRET The return code for the function
/// HIRET 0 for no error
/// HIPAR file/File to read
/// HIPAR file/Pass the full pathname of the file
int MyFunction (char *file)
{
}

[kevin.key]

Yes, but not for the header file tags, and it also inserts a new line.

Does anyone know how to generate help with the style that most built in libraries have? For instance if you look at ANSI C -> Character Handling -> Character Testing -> isalnum(), in the tree view on the right, right-click and view the Function Help... and especially look at the style of isalnum() in the CVI Help under the Library Reference section.

If I generate a function tree from a .h file with documentation tags in it, the output is very text like. If I set the release to Debug and generate HTML documentation from the .c file and then generate a function tree linking to the HTML files that I just generated it gets the closest to the style of the built in libraries but not all the way there and the links get broken in the process.

-----------

Also, kind of a similar topic, but does the function completion stuff only work when the release is set to Debug, because that's what I'm seeing.

[AllenHuffman]

Same question in 2023.