Apr 20th, 2024 at 11:55am (UTC)
 
 

Before logging an issue, please update to the latest release of Visual Micro from the Downloads Page.

When Logging a Support Issue in the Forum, please ensure you have also:-

  • Enabled vMicro > Compiler > Show Build Properties
  • Re-Compile your program with these settings enabled
  		Save the new Output to a Text File and....
  • Click the Reply button and attach as .txt file OR
  • Click here to Email us with the file attached, and a link to your post
Support requests without the output above may be impossible to answer, so please help us to help you
 
  VS Arduino › Visual Micro › Visual Studio 2017, 2019, 2022 › Documentation tools for VS2015?
‹ Previous Topic | Next Topic ›
Page Index Toggle Pages: 1 Send TopicPrint
Normal Topic Documentation tools for VS2015? (Read 4286 times)
nevereven
Junior Member
**
Offline


Posts: 59
Joined: Dec 5th, 2014
Documentation tools for VS2015?
Apr 4th, 2016 at 4:40pm
Print Post  
I'd like to get better at documenting my code. Can anyone suggest a good free or cheap solution for this.

I've read about Doxygen, but DoxygenComments  isn't maintained or supported with VS2015.

There's Atomineer  but it's $60 which is too steep for me right now.

Any other suggestions?
  
Back to top
 
IP Logged
 
Tim@Visual Micro
Administrator
*****
Offline


Posts: 12076
Location: United Kingdom
Joined: Apr 10th, 2010
Re: Documentation tools for VS2015?
Reply #1 - Apr 5th, 2016 at 3:22pm
Print Post  
Not sure but worth looking at the standard xml documentation facility in visual studio

https://msdn.microsoft.com/en-us/library/ms177226.aspx?f=255&MSPPError=-21472173...
  
Back to top
WWW  
IP Logged
 
Pascal Roobrouck
Junior Member
**
Offline


Posts: 19
Joined: Mar 3rd, 2017
Re: Documentation tools for VS2015?
Reply #2 - Nov 15th, 2017 at 9:25am
Print Post  
I've added some /// comments in my code to document the classes, but the XML file is not being generated
Adding the /doc flag to the 'extra flags' results in following build error
arm-none-eabi-g++*: error: \doc: no such file or directory

What else is needed in Visual Micro project settings, to generate the XML ?
  
Back to top
 
IP Logged
 
Tim@Visual Micro
Administrator
*****
Offline


Posts: 12076
Location: United Kingdom
Joined: Apr 10th, 2010
Re: Documentation tools for VS2015?
Reply #3 - Nov 15th, 2017 at 8:07pm
Print Post  
The build system is arduino/GCC and not Microsoft C++. the gcc system does not support xml output 

You will need to look at the various tools available from third parties. These are available in the microsoft visual studio gallery. I haven't tried them sorry.
  
Back to top
WWW  
IP Logged
 
Pascal Roobrouck
Junior Member
**
Offline


Posts: 19
Joined: Mar 3rd, 2017
Re: Documentation tools for VS2015?
Reply #4 - Nov 19th, 2017 at 3:38pm
Print Post  
Ok, thanks.

I can't find any extensions to generate the documentation from the source-code itself (as this is normally done with the VS compiler, this makes sense)
I can see many plugins to insert triple-slash comments into the source code..

I installed doxygen, which does generate documentation outside of Visual Studio

thanks for your support.
  
Back to top
 
IP Logged
 
Tim@Visual Micro
Administrator
*****
Offline


Posts: 12076
Location: United Kingdom
Joined: Apr 10th, 2010
Re: Documentation tools for VS2015?
Reply #5 - Nov 20th, 2017 at 12:34pm
Print Post  
Here are a couple

https://www.atomineerutils.com/

https://marketplace.visualstudio.com/items?itemName=sergeb.GhostDoc
  
Back to top
WWW  
IP Logged
 
Page Index Toggle Pages: 1
Send TopicPrint
‹ Previous Topic | Next Topic ›
 
  « Board Index ‹ Board Top  

VS Arduino » Powered by YaBB 2.6.12!
YaBB Forum Software © 2000-2024. All Rights Reserved.