LabWindows/CVI

cancel
Showing results for 
Search instead for 
Did you mean: 

severe documentation error for SortTreeItems

Using LabWindows/CVI 8.1.1, in the HTML Help:

function SortTreeItem, parameter comparisonFunction is described as being of type TreeCellCompareCallbackPtr, which is described as:
int CVICALLBACK FunctionName (int panelHandle, int controlID, int item1, int item2, void *callbackData);

when it is declared in <userint.h> as:
typedef  int (CVICALLBACK * TreeCellCompareCallbackPtr)(int panel, int control, int item1, int item2, int keyCol, void *callbackData);

also i would like to add: can't you make a standalone page for a type like this and link to that page, instead of documenting the type in the dexription of the parameter using this type ? that would:
- make a shorter and clearer documentation for every function using callback functions as parameters
- make a single entry-point for every function using this type instead of copying the definition at every places it is used
- add an entry to the index allowing to easily find the definition of the type !
- give a formal definition of the type without having to search throughout the header file to find the typedef
- hopefully avoid the kind of error i am reporting here since the page could be generated automatically from the definition of the type...
0 Kudos
Message 1 of 2
(2,891 Views)
Thanks for reporting this. We'll be sure to correct the documentation.

I agree that it can sometimes be more convenient to split up, via links, the complex data types from the rest of the documentation. And of course, that also results in less duplication, which does cut down on errors.
The reason the CVI documentation doesn't do that more (it's only done very rarely, for error tables, for example) has to do with the fact that most users get their library reference help from function panels, rather than the external, online help. And in function panels, it's not very convenient to have to follow links, since links open in the external help viewer. Abd the help content (as of CVI 6.0 and later) is exactly the same between function panels and the external help. In other words, one is generated from the other.
Technically speaking, it is of course possible to generate the two versions of the content so that one has links and the other doesn't. It's not trivial, but it's certainly possible. We'll consider doing that in the future.

Luis
0 Kudos
Message 2 of 2
(2,877 Views)