09-30-2008 04:49 AM
Hello,
Is there any tool to generate HTML documentation directly from C sources files using Documentation Tags like "/// HIFN "?
I know we can generate documentation with function panels documentation generator but that's not what I'm looking for. I'm looking for something like doxygen or javadoc with NI documentation tags support.
Regards,
Aurélien.
10-01-2008 09:56 AM
Hello,
In LabWindows CVI, there isn't tool which can allow you to generate automatically HTML documentation from C sources, like with eclipse for exemple (java).
Regards,
Nacer M. | Certified LabVIEW Architecte
10-01-2008 10:07 AM
Ok, thanks for your answer.
Regards,
Aurélien R.
10-06-2008 04:06 AM
10-08-2008 04:12 AM
HI,
we use in our company "doxygen" (doxygen.org), a tool which can create the documentation from special comments in c (or h) files. It's possible to add a CVI-docu-stylish parser to this open-source-tool. We've also a small prog, which translates the cvi-HIFN to some tags which can be used by doxygen, I will have to look for...
regards
Peter
10-13-2008 08:17 AM
Thank you very much for all your answers. I'll take a look on Doxygen.
Aurélien
03-14-2011 08:39 AM
Instead of using a separate tool for replacing CVI tags with doxygen tags before running doxygen,
you might also use the doxygen input filter.
I use "sed.exe" (unix Stream EDitor) from the cygwin package as input filter. (you need to copy sed.exe, cygconv-2.dll, cygintl3.dll and cygwin1.dll to your doxygen bin folder) .
Add the input filter to your Doxyfile, e.g.:
INPUT_FILTER = "sed 's/HIFN//g;s/HIPAR/\\\param/g;s/HIRET/\\\return/g'"
03-14-2011 10:11 AM
INPUT_FILTER = "sed '/HIPAR/s/^\// /4;/HIRET/s/^\// /4;s/HIFN//g;s/HIPAR/\\\param/g;s/HIRET/\\\return/g'"
(same as before but replaces every 4th slash of every HIPAR/HIRET line with blank)
08-13-2014 10:27 AM
Has anyone here tried the open source project Natural Docs? It looks to be very unobtrusive (unlike Doxygen) to your existing commenting style.
I have not yet implemented it in my code, but I'm going to give it a whirl.
08-14-2014 03:54 AM
Hello AReeves!
LabWindows/CVI features a documentation generation tool able to output HTML and XML format documentation from your C source files.
You can use the source code documentation tags (e.g. HIFN, HIPAR, etc) to document your functions in the source code, similar to doxygen.
The option is located in Build » Target Settings » Generate source code documentation. There you can select your output format.
Here is a useful link related to generating documentation from source files using CVI:
http://zone.ni.com/reference/en-XX/help/370051T-01/cvi/usermanual/tagsforsourcecode/
Regards,
- Johannes