Documentation tags / hierarchical ?

[gdargaud]

Hello all,

when using documentation tags (HIFN, HIPAR, etc), how do you manage the Hierarchical Function Index ? It's identical to the alphabetical one, so I guess something must be missing ? The documentation is not helpful on the matter.

Thanks

[ChaisePotato]

Gdargaud,

Have you checked the CVI manual for Hierarchical Function Index? This might have some good information for you: https://www.ni.com/docs/en-US/bundle/ni-system-configuration-c-ref/page/nisyscfgcvi/hierarchical_fun...

[gdargaud]

Hello,

I feel like I'm missing something. This is just a page about a bunch of hardware-related functions. Granted, they are organized hierarchically but I feel like the title of the page is simply wrong.

How do you manage such a hierarchy through the use of documentation tags ?

[Johannes_T · Accepted solution]

Hello gdargaud!

Thank you for bringing this topic up for discussion!

The documentation generation mechanism in CVI can be used differently across features in CVI. There are several ways in which users are able to generate documentation from source code/FPs and vice versa:

1. Documentation generation from source code (using browsing information): https://www.ni.com/docs/en-US/bundle/labwindows-cvi/page/cvi/usermanual/tagsforsourcecode.htm
• Using Build » Target Settings » Generate help from source when building a project.
2. Documentation generation from function panels: https://www.ni.com/docs/en-US/bundle/labwindows-cvi/page/cvi/usermanual/fteoptionsgeneratedoc.htm
• Using Options » Generate Documentation menu item from an opened function tree.
3. Function panel generation from documented source code: https://www.ni.com/docs/en-US/bundle/labwindows-cvi/page/cvi/usermanual/srcoptgenfunctree.htm
• Using Options » Generate Function Tree menu item from an opened header file.

I suspect that you are refering to the first feature regarding how one would generate/manage the Hierarchical Function Index. Is this true? Unfortunately, generating documentation from source code using browsing information only supports a limited set of documentation tags and so all decorated functions are presented in a top-level view.

It is the second and the second feature that provides the ability to manage the hierarchical structure of the functions and function panels. The fact that the documentation output looks the same is because for consistency, they use the same underlying mechanism.

Best regards!

- Johannes