Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
User name:
Password:
Save Password
Forgot your password?

 All Forums
 Visual Assist
 Technical Support
 Document method
 New Topic  Reply to Topic
 Printer Friendly
Author Previous Topic Topic Next Topic  

mmerkel
New Member

Germany
2 Posts

Posted - May 29 2019 :  04:45:45 AM  Show Profile  Reply with Quote
Please excuse if this had been discussed earlier, but I'm pretty new to Visual Assist.
I'm looking for a way to generate Doxygen enabled function headers for C source code using 'Quick Actions and Refactoring (VA) -> Document Method' from the context menu when right-clicking on a function prototype. This is nice as is looks though all the function parameters and adds them to the header as \param directives. For \param I also can add the optional attributes [in], [out], etc. that are quite useful for API documentation. Is there any way that I could annotate my C code such that Visual Assist would extract those annotations during method documentation to generate the corresponding Doxygen directives? I�m aware of SAL however despite working from within Visual Studio, I use a makefile project and a GNU ARM compiler that does not seem to be aware of sal.h.

feline
Whole Tomato Software

United Kingdom
19020 Posts

Posted - May 29 2019 :  2:00:55 PM  Show Profile  Reply with Quote
If I understand correctly then no, this is not an ability VA has.

We are considering allowing Document Method to separate out the SAL information for each parameter, if present, but this has not yet been done:

case=84805

We don't look for any other information like this either.

zen is the art of being at one with the two'ness
Go to Top of Page

mmerkel
New Member

Germany
2 Posts

Posted - Jun 03 2019 :  02:46:34 AM  Show Profile  Reply with Quote
Ok, thanks, than we have to live with adding those attributes manually for now.
Go to Top of Page
  Previous Topic Topic Next Topic  
 New Topic  Reply to Topic
 Printer Friendly
Jump To:
© 2023 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000