LabWindows/CVI Idea Exchange

cancel
Showing results for 
Search instead for 
Did you mean: 
0 Kudos
tstanley

Documentation tags inprovements

A couple of minor things:

1.  Change it so that if characters like 'µ' are used in the documentation tags, that CVI doesn't generate invalid XML comments files.  Or if that is not possible warn the user if they use characters like 'µ' in the documentation tags.

2.  Make it so that Insert Construct -> Function Documentation Tags (Ctrl-Shift-G) doesn't insert an HIPAR paramater for 'void' for functions that don't have parameters.  Also make it so that it doesn't insert HIRET tags for functions that don't return anything.

5 Comments
tstanley
Active Participant

3.  Insert Construct -> Function Documentation Tags (Ctrl-Shift-G) places the documentation tags in the incorrect place for a function that returns a structure or a pointer to a structure.  The tags seem to be placed above the first previous function that returns one of the standard types or void.

LuisG
NI Employee (retired)
Status changed to: Under Consideration
 
tstanley
Active Participant

4.  Insert Construct -> Function Documentation Tags (Ctrl-Shift-G) does odd things for parameters that are function pointers.  Instead of interserting a parameter for the function pointer name it inserts parameters for the function pointer's argument type(s).  i.e. the following protytpe:

 

int __stdcall SetDeferredCallPtr(void CVICALLBACK DeferredFunction (void *))

 

will insert a parameter for "void" but not "DeferredFunction ".  Thanks. 

tstanley
Active Participant

5.  Generate valid XML when < > characters are used in the comments tags, and/or throw up a warning when these characters are used.

tstanley
Active Participant

6.  Suggest a new documentation tag which would automatically be generated for functions that have the CVICALLBACK label on them, which would allow the user to specify what that callback function is used for (control callback, deferred callback, etc.)