Example: Comments Starting on the Same Line as the Symbol

Doc-O-Matic associates the comment with the preceding symbol, as in the following example.

int Foo(int i, int k); // This is the text for Foo.
void Bar();            // This is the text for Bar.

The two comments will be associated with the functions Foo and Bar.

If the comment block has more than one line, the whole comment block will be used as documentation of the symbol. This rule applies here too:

int Foo(int i, int k); // This is the text for Foo.
                       // This is more documentation for Foo.
                       // And even more documentation for Foo.
void Bar();            // This is the text for Bar.

Here the documentation for Foo would be:

This is the text for Foo. This more documentation for Foo. And even more documentation for Foo.