CODEWITHSUNDEEP
c++netbeansdocumentationcomments
chraz
chraz

Reputation: 134

How to comment C function in netbeans, so documentation hint will be formatted (bold, paragraphs ...)

/**
 * A test function
 * @param p an integer **of your choice**
 * @return 0: if zero, 1: if positive, -1: if negative
 */
int Test(int);

I want the documentation hint to be formatted as :

But instead, i get :

enter image description here

Upvotes: 2

Views: 1056

Answers (1)

masoud
masoud

Reputation: 56509

Put <b> YOUR TEXT </b> instead of **.

 /*
 * @param p an integer <b>of your choice</b>
 *                     ^^^              ^^^^
 */

For multi line, you can use <br> or \n at the end of line. You can also take advantage of other HTML text formatting tags:

<b> - Bold 
<strong> - Important 
<i> - Italic 
<em> - Emphasized 
<small> - Small 
<sub> - Subscript 
<sup> - Superscript

Upvotes: 2

Related Questions