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
 
Page Index Toggle Pages: 1 Send TopicPrint
Normal Topic Intellisense problem with Doxygen-style comments (Read 7509 times)
vyruz
Junior Member
**
Offline


Posts: 10
Joined: Jan 3rd, 2015
Intellisense problem with Doxygen-style comments
Sep 5th, 2015 at 1:39pm
Print Post  
Hi,

I've used the Atomineer plugin as suggested on the Visualmicro website to generate comments for my code.
This has resulted in XML comment blocks before each of my functions, like so:
Code (C++)
Select All
////////////////////
///<summary>
///   Change dog state. If byNewDogState is different from current one
///</summary>
///
///<remarks>
///   Alex, 05/09/2015.
///</remarks>
///
///<param name="byNewDogState"> State of the new dog. </param>
////////////////////

void RaceHandlerClass::_ChangeDogState(_byDogStates byNewDogState)
{
   if (_byDogState != byNewDogState)
   {
      _byDogState = byNewDogState;
      if(bDEBUG) Serialprint("DogState: %i\r\n", byNewDogState);
   }
} 



I would assume the contents of these comments would be shown in Intellisense popups when it's autocopleting my code, yet I don't get to see any of them. 

I've attached a snippet of what the Intellisense popup of the function above shows.

At work we use VisualStudio 2010 to code PHP (using DevSense PHP plugin), and there this works fine.

Am I doing something wrong?

Edit: Should have mentioned I'm using:
- Visual Studio 2015
- Arduino IDE 1.6.5
- VisualMicro 1.1508.14
« Last Edit: Sep 5th, 2015 at 1:42pm by vyruz »  

Please Register or Login to the Forum to see File Attachments
Back to top
 
IP Logged
 
Tim@Visual Micro
Administrator
*****
Offline


Posts: 12071
Location: United Kingdom
Joined: Apr 10th, 2010
Re: Intellisense problem with Doxygen-style comments
Reply #1 - Sep 5th, 2015 at 4:35pm
Print Post  
Vs should support whatever its C++ system supports. Visual Micro doesn't have any control over it so please check the VS documentation.

If Aomineer doc is out of date let me know and I will remove it.

Thanks

I know this would work in std. C++ without atomineer

Code
Select All
/// <summary>loop is a method in the sketch.
/// <para>Here's how you could make a second paragraph in a description. <see cref="Serial.print"/> for information about output statements.</para>
/// <seealso cref="some other method"/>
/// </summary>
void loop()
{

  /* add main program code here */
	Serial.available();

} 

« Last Edit: Sep 5th, 2015 at 4:54pm by Tim@Visual Micro »  
Back to top
WWW  
IP Logged
 
Tim@Visual Micro
Administrator
*****
Offline


Posts: 12071
Location: United Kingdom
Joined: Apr 10th, 2010
Re: Intellisense problem with Doxygen-style comments
Reply #2 - Sep 5th, 2015 at 4:56pm
Print Post  
and I tried your comment but the blank line between the method and documentation causes VS not to display the comment in the intellisense
« Last Edit: Sep 5th, 2015 at 4:56pm by Tim@Visual Micro »  
Back to top
WWW  
IP Logged
 
vyruz
Junior Member
**
Offline


Posts: 10
Joined: Jan 3rd, 2015
Re: Intellisense problem with Doxygen-style comments
Reply #3 - Sep 5th, 2015 at 7:06pm
Print Post  
Tim@Visual Micro wrote on Sep 5th, 2015 at 4:56pm:
and I tried your comment but the blank line between the method and documentation causes VS not to display the comment in the intellisense


Thanks that indeed fixed it.
Atomineer settings contain an 'Enforce blank line' setting but it's set to put 1 line before and 1 after each comment.
So you might update your article to include this. Although reading your comment it seems like a bug in Atonimeer.

Also, my example (with the slash line seperator) did not work entirely, I got the intellisense popup but it just showed me the complete comment block, and did not seem to manage to parse it correctly (I could see the <summary> etc tags in the intellisense).

When I tried your example it worked perfectly, so I reconfigured atonimeer to make all comments like this.

Thanks for your help! Glad I'm a paying VM user Smiley
  
Back to top
 
IP Logged
 
Tim@Visual Micro
Administrator
*****
Offline


Posts: 12071
Location: United Kingdom
Joined: Apr 10th, 2010
Re: Intellisense problem with Doxygen-style comments
Reply #4 - Sep 5th, 2015 at 7:19pm
Print Post  
Thanks very much for the update (and for buying visual micro)

I have updated the Atomineer documentation and also added a link to the Microsoft C++ Xml Documentation pages which might also be relevant.
« Last Edit: Sep 5th, 2015 at 7:30pm by Tim@Visual Micro »  
Back to top
WWW  
IP Logged
 
Page Index Toggle Pages: 1
Send TopicPrint