Inline function commenting

[cburrell]

Hi All,

I'm using the HTML Documentation generator, but have one small problem.

I've figured out most of the commenting rules (by trial and error - where is the documentation for this?), but can't quite figure out where to place a comment in my code to document an inline function.

With a non-inline function, you place the comment on the line immediately preceding your function:

<code>
       /// <sumary>
       /// CMyClassDlg Initialisation function
       /// </summary>
       ///
       /// <purpose>
       /// Initalises the window control members to show the correct data when the window is displayed.
       /// </purpose>
       ///
       /// <revisions>Revisions:
       /// <revision no="0">061211 - CB - Comment added</revision>
       /// </revisions>
       BOOL CMyClassDlg ::OnInitDialog()
</code>

But how do you do the same with an inline function?

Thanks in advance,

C

[Eve]

EA has options for where to find comments to C++ functions.  (Tools | Options | C++)

For inline functions to be documented you'll need to have 'Method Notes in Header' set to True.  Then put your comments immediately before the declaration.

(You may also want to set the 'Comment Style' option to XML.Net)