Questions tagged [atomineer]

Atomineer Pro Documentation is an extension for Microsoft Visual Studio that provides documentation-comment authoring facilities.

Atomineer Pro Documentation (formerly AtomineerUtils) is an extension for Microsoft Visual Studio that provides documentation-comment authoring and maintenance facilities, to save time when documenting code.

It is able to generate documentation comments for code elements based on their context, and provides many features such as updating of comments to keep them in sync with the code (e.g. as parameters are added or renamed), formatting such as word-wrapping the documentation and enforcing a particular style, layout and entry ordering, and live typing aids to improve the formatting of text as you type and paste into comment blocks.

It supports many languages (C#, C++/CLI, C++, C, Java, JavaScript, Typescript, PHP, Python, Unrealscript, Visual Basic) and documentation styles (Xml Documentation, Doxygen, JavaDoc and Qt), and is able to convert legacy comments into and between any of these formats.

Ask questions using this tag if you need help configuring Atomineer to produce the documentation results you require, although in general you will get a faster response if you contact Atomineer directly.

More information can be found on the official website for this extension: atomineerutils.com

8 questions
4
votes
2 answers

Atomineer: Determine if return type is const

I'm using Atomineer 9.00 to format my code comments, but I'm having difficulty trying to determine if a return type is const or not. The documentation states that for MethodReturns, using %type% will provide the full return type (the example given…
Tas
  • 7,023
  • 3
  • 36
  • 51
3
votes
2 answers

Uninstall Atomineer

Looks like I am being held hostage by the Atomineer Pro Documentation add-in for Visual Studio! The trail period is over, I have no use for it! But now everytime I do something in Visual Studio I get an error message and get sent to their web…
2
votes
1 answer

Modifying rules in Atomineer

I am using @remarks and @ingroup in my comment blocks but when I run Atomineer it keeps marking them for deletion and I'm not sure how to keep it from doing this. I looked at modifying rules in the .XML configuration files but I'm clearly missing…
Bryan C.
  • 143
  • 1
  • 8
1
vote
1 answer

Visual Studio 2013 not handling Doxygen multi-line comments correctly

I am using Visual Studio 2013 (C++) with the Atomineer Utils add-in. Coming from a Java background, I was interested in the Doxygen style of documentation, so I configured Atomineer to use the Doxygen (Javadoc) style, which looks like this…
octopod
  • 824
  • 2
  • 10
  • 23
1
vote
1 answer

Separate templates per file type when using Atomineer

I am using Atomineer 7.31 to format my C++ files, but I'm having trouble creating separate behaviour for different file types. As an example, I'd like to populate my .cpp files with certain information such as including the .h file with the same…
Tas
  • 7,023
  • 3
  • 36
  • 51
0
votes
1 answer

Atomineer Utils VB.NET XML Comment Documentation Not Working

I just downloaded the trial for this application and it doesn't seem to work. I went through the Quick Setup guide and it all looked great. Now when I place my cursor on a member of any type and press Ctrl+Shift+D it does nothing. I placed it on…
Shane LeBlanc
  • 2,633
  • 13
  • 42
  • 74
0
votes
1 answer

Per-solution Atomineer preferences

With Atomineer Pro Doc for VS, is it possible to have the (some?) settings/preferences saved in the current $(SolutionDir) directory? I realize that there is an option to save/use the prefs.xml file from locations other than the default by setting…
dxiv
  • 16,984
  • 2
  • 27
  • 49
0
votes
1 answer

Atomineer and documenting methods with generic constraints

I'm using Atomineer to auto generate documentation comments in my code. All seems to be working fine except I'm running into an issue with getting doc comments on methods with multiple generic constraints: Comments will auto-generate on a method…
Aaron Salazar
  • 4,467
  • 10
  • 39
  • 54