When does DelphiCodeToDoc start a new Line

[Kingetje]

Hi,

First of all, I must say that this tool is wonderful.  It is so good, I'm gonna change the way our company handles inline documentation so that it follows the JavaDoc standards.

Currently I am testing a few things, and I have some questions about the formatting of the output.  It looks like the Output will contain <BR> HTML tags each time you start a new line in the editor.  This results in some strange formatting in the output.

Maybe I am doing something wrong, so I'll show you a comment header I am using and will try to explain what the result is :

{*****************************************************************************
  This function will convert a given TDateTime to a string using the YYYYMMDD
  format.

  @Name        DateAsYYYYMMDD
  @Author      sLesage
  @Param       aDateTime     The DateTime that must be converted to a String.
  @Exception   None
  @Return      The given TDateTime represented as a string in the YYYYMMDD
               format.
  @See         DateAsDDMMYYYY
*****************************************************************************}

function DateAsYYYYMMDD( const aDateTime : TDateTime ) : String;
begin
  Result :=
    LeftFill( IntToStr( YearOf ( aDateTime ) ), 4, '0') +
    LeftFill( IntToStr( MonthOf( aDateTime ) ), 2, '0') +
    LeftFill( IntToStr( DayOf  ( aDateTime ) ), 2, '0');
end;

As you can see the description is a bit too long to fit on one line ( general policy in the company is that a Source line should not exceed 80 characters ).  So the 'Format' word is on a seperate line.  When generating the Documentation this will result in a <BR> tag being inserted before the word 'Format' and that isn't quite what I expected.

The result is that in the Functions summary of the unit the word 'Format' isn't included in the short description for the function because it seems to be on a new line.

Is there some way to make the application see that the word 'Format' shouldn't be seperated by a new line ?

Regards, and keep up the good work.

Kingetje

[TridenT]

Thanks for your words, it is good to have some feeling from users.

For your question, it is a JavaDoc limitation.
http://java.sun.com/j2se/javadoc/writingdoccomments/#descriptions

>>>This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first tag

They speak about "sentence", but it is always contained in the first line.
So ... you should write shorter summary!
For the moment, I don't know what to do.
It is "possible" to parse the first sentence until the first period, but ...

But, for the moment, I'd like to keep the same comment presentation between source code and HTML documentation.
So ... I will try with other comment tool (doxygen), and see what it does.

If it is really important for users (not just u!), and you can't do in other way (I'm sur you can), I will add an option to parse until the first period, but it will change the documentation canevas.