Book a Demo

Author Topic: Formatting code comments in HTML documentation?  (Read 2012 times)

cburrell

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Formatting code comments in HTML documentation?
« on: December 04, 2006, 02:44:29 pm »
Hi There,

I'm new to EA, so please excuse me if this is a silly question.

I'm using the HTML Documentation feature of the Class Model , but I am having trouble with the formatting of the comments in my code.

In my code I might have something like:

<snip>
/*----------------------------
PROCEDURE: CMyClass default constructor

PURPOSE: Called when a CMyClass object is created. Initialises member variables.

PARAMETERS: None.
------------------------------*/
CMyClass::CMyClass()
{
</snip>

Which is fine, but when I generate the html documentation, it comes up thus:

<snip>
Sequential

Notes:
----------------------------------------------------------------------------- PROCEDURE: CMyClass default constructor PURPOSE: Called when a CMyClass object is created. Initialises member variables.  PARAMETERS: none -----------------------------------------------------------------------------
</snip>

ie, there is no formatting like new lines and so on.

I've tried altering the comment in my code - by adding such things as "<br>"'s and "\n"s and so on, but have had no luck.

Can anyone help me with this?

Many Thanks,

Chris