Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>(I'm the author of <a href="http://www.atomineerutils.com/" rel="nofollow">Atomineer Pro Documentation</a>)</p> <p>In Visual Studio, </p> <ul> <li>Go to Tools > Atomineer > Atomineer Options... </li> <li>Switch to the "Advanced Customisation" tab </li> <li>Click the <b>Block Templates - Doxygen</b> button. </li> </ul> <p>An editor (Notepad) will be opened containing the templates for you to customise.</p> <p>The templates are XML-based, and they dictate to Atomineer:</p> <ul> <li>Which entries are legal (required or optional). Any entries not mentioned are considered "illegal" and deleted as you have found.</li> <li>The order in which entries should be sorted when comments are generated/updated</li> <li>Where to put additional whitespace (blank lines) in the comment blocks</li> <li>A few other things like whether punctuation correction should be enabled/disabled for each entry etc</li> </ul> <p>There is a template for each different type of code element Atomineer can document, so you can get quite fine control of exactly how every part of your documentation looks, but it does mean you will have to copy and paste your new elements into each of the templates.</p> <p>For example, here is the default template for a Doxygen method comment:</p> <pre><code> &lt;method&gt; &lt;prototype _punctuate="false" /&gt; &lt;_ /&gt; &lt;summary /&gt; &lt;_ /&gt; &lt;author _punctuate="false"&gt;%user%&lt;/author&gt; &lt;date _punctuate="false"&gt;%date%&lt;/date&gt; &lt;_ /&gt; &lt;exception /&gt; &lt;_ /&gt; &lt;param /&gt; &lt;_ /&gt; &lt;returns /&gt; &lt;_ /&gt; &lt;sa _punctuate="false" _optional="true" /&gt; &lt;/method&gt; </code></pre> <p>Each XML element (line) in this describes one entry in the comment. e.g. The XML tag <code>&lt;param/&gt;</code> corresponds to where the <code>@param</code> entries will be placed in the final comment block. The special element <code>&lt;_/&gt;</code> is used to indicate where blank lines should be inserted. (prototype is a special doxygen one, telling it where to insert the prototype/declaration @fn, @class, etc)</p> <p>To allow <code>@ingroup</code> and <code>@remarks</code> to be inserted into Atomineer comments, just add entries for them in the positions you want it to appear in the comment, like this:</p> <pre><code> &lt;method&gt; &lt;prototype _punctuate="false" /&gt; &lt;ingroup _optional="true" /&gt; &lt;_ /&gt; &lt;summary /&gt; &lt;_ /&gt; &lt;remarks _optional="true" /&gt; &lt;_ /&gt; &lt;author _punctuate="false"&gt;%user%&lt;/author&gt; ... &lt;/method&gt; </code></pre> <p>You will see that the example elements I've added have the attribute <code>_optional="true"</code> in them. Without this, Atomineer will add the entry to every comment (a required entry). If it is set to <code>true</code>, then the entry will not be <em>added</em> by Atomineer, but if you type it in yourself, Atomineer will make sure to preserve it when you update a doc-comment.</p> <p>I apologise for how involved this is, but it's a flexible system that allows everybody to get what they want, albeit sometimes requiring a few minutes of setting up. Whenever I get time I am writing improved configuration tools and tutorials to make this process easier. Once you've configured it, though, you should have many happy years ahead ;-)</p> <p>There is more documentation on Templates and the other things you can do in them <a href="http://www.atomineerutils.com/rulesguide.php" rel="nofollow">here</a>.</p> <p>If you have further questions, feel free to drop a line to the support email, which is at the bottom of every page on the Atomineer website. I'm always happy to help.</p>
    singulars
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. This table or related slice is empty.
    2. VO
      singulars
      1. This table or related slice is empty.
    3. VO
      singulars
      1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload