LabWindows/CVI Idea Exchange

cancel
Showing results for 
Search instead for 
Did you mean: 
r_exler

HTML documentation for variables and structures

Status: New

It would be great to add the possibility to include documentation for (especially global) variables and data structures to the HTML documentation. Currently only functions could be documented. And it would make no sense to duplicate information about data structures used as parameters in each function which is using it.

 

It would further make sense to structure the HTML documentation at least by the module (.C file) it is defined in, together with the variables and data structures. Such you would get a tree like HTML doc with the modules as 'chapters', then sections for data structures, variables and functions. At the moment I get one big HTML index with documentation from all functions within the project sorted by name (I have not been able to find out how to get another structure in the 'functional index').

 

In best case there should be a chance to group 'public' data structures, variables and functions independent of 'private' ones to clearly identify the ones which are the intended interface functions and which are module internal helping functions. One way to automatically distinguish between this types might be using all functions documented in .H files as public and documentation from within .C files as private.

 

Best regards,

  Roland Exler

2 Comments
gvan
Member

also nice would be if CVI IDE recognized doxygen style comment tags in addtion to the '///' CVI ones. Even better, have documentation markup configuratable or settable so that developers have the option to use their own documentation generation tools (or a subset of popular ones), but can still make use of CVI 'popup' help for documented functions.  

Peter_Prinzen
Member