Doxygen vs Function Tree Generation Markup, round one

[pedwards]

We are using LabWindows/CVI 7.1 with an instrument driver.  The function panels got lost, trashed, floated around the hard drive for a while, and when they were rediscovered, they had become badly out of sync.  Trying to fix them all up by hand would be a long and tedious process, so I'm just going to regenerate them from the driver's header file from scratch.

However, since the time the FPs were first generated, the driver header file has undergone two major changes:
1)  Large parts have been split out into smaller header files, which the main header file #includes rather than declaring all the functions and enumerations directly, and
2)  Doxygen markup has been added to everything.

After browsing the knowledge base, I've learned that (1) isn't supported.  No problem; for the process of generating the .fp file, I can glue the headers back into one file temporarily.

But the special format comments in (2) seem to be an issue.  The CVI help file says:

Do not use additional comments in enums; the // comment specifies an optional label for each enum value. [...]  Avoid semicolons inside enumeration lists, including comments.  [...]  Avoid nested comments or combination of comment styles (//, /**/, or /* // */).  [...] 

Trying to extract declarations gives some strange results, and I think it's because of the Doxygen markup.  At the same time, we're considering adding CVI markup to the input file (e.g., "/// SLD 2"), but triple-slashes are also used by Doxygen and would break the documentation generation.

So, after all that verbage, my question:  have any of you used Doxygen with your header files when generating function panels, and if so, how did you handle the comment markups?  I'm considering just making a temporary version of the header, with comments removed, and using that for FP generation, then throwing it away and returning to the "real" version.

[Brandon_V]

pedwards,

You will not be able to have the extra comments for Doxygen markup in a header file you use to generate the Function Panel. This is because the Function Panel Generator looks at these comments for information specific to the function panels. Once the function panels are generated, you will have no problem having these comments in the header, but it would probably be best to create a new header for use in the function panel generation and then replace it with the one you are currently using.