Is XML Documentation in Delphi 10.4 is 105% broken?

[Lajos Juhász 238]

I've tried to compare XML documentation in XE5 and 10.4. For this I've copied an example from the documentation http://docwiki.embarcadero.com/RADStudio/Sydney/en/XML_Documentation_Comments:

/// <summary> Removes the specified item from the collection
/// </summary>
/// <param name="Item">The item to remove
/// </param>
/// <param name="Collection">The group containing the item
/// </param>
/// <remarks>
/// If parameter "Item" is null, an exception is raised.
/// <see cref="EArgumentNilException"/>
/// </remarks>
/// <returns>True if the specified item is successfully removed;
/// otherwise False is returned.
/// </returns>
function RemoveItem(Item: Pointer; Collection: Pointer): Boolean;
begin
  // Non-XML DOC comment
  // ...
end;

In the attachment its clear that 10.4.1 in order to save some space will combine summary, parameter descriptions, remark and return value. I why is this changed?

[Der schöne Günther 306]

The "express edition" of Documentation Insight was only bundled with RAD Studio until XE5.

After that, it was removed.

 

Source:

DevJet Software » Documentation Insight Express has been released with RAD Studio XE2

 

As far as I can remember, you should be able to copy some files from your XE5 installation over to a new RAD studio version and the mouseover will still display as it did in previous versions.

 

 

 

Edited December 29, 2020 by Der schöne Günther

[Lajos Juhász 238]

Unfortunately this is Help Insight. For example http://docwiki.embarcadero.com/RADStudio/Sydney/en/Help_Insight show a picture as it was in Delphi XE5. So the expected behavior is still to generate a readable definition of the function.

[Lachlan Gemmell 33]

If I remember correctly the DevJet Documentation Insight version that was bundled with previous IDE versions had a template that improved the appearance of the Help Insight.

 

See here for more info from DevJet. Whether you should use the version from the DevJet site or from your XE5 I'm not sure.

[Lajos Juhász 238]

Unfortunately this is a well known bug in Delphi 10.4 - there was a bug report that I didn't found at first - https://quality.embarcadero.com/browse/RSP-30690 the report is from July an still open.

 

I was a bit shocked that nobody noticed in the betas.

[Uwe Raabe 1879]

1 hour ago, Lajos Juhász said:

I was a bit shocked that nobody noticed in the betas.

How would you know that? It might as well been noticed, but either too late or of lower priority to make it into the release.

[Lajos Juhász 238]

2 minutes ago, Uwe Raabe said:

How would you know that?

The oldest bug report is from July and it's not marked as duplicated if it was a known issue they would flag it.

[Lajos Juhász 238]

It's now working again in Delphi 10.4.2.