XS1569: Error writing to XML documentation file

This forum is meant for questions and discussions about the X# language and tools
Post Reply
User avatar
pemo18
Posts: 72
Joined: Fri Apr 27, 2018 10:38 am
Location: Germany

XS1569: Error writing to XML documentation file

Post by pemo18 »

Hello X# Team,


Whenever I put a

/// <summary>

above a single class definition the whole project does not compile anymore due to an infamous XS 1569 error:

XS1569: Error writing to XML documentation file: Fehler beim Vergleichen von zwei Array-Elementen

Luckily the error goes away when I removed the line. So everything is fine.

Is there anything wrong with this comment?

The line below the /// <summary> line are two simple comment lines that each starts with // and there is no closing /// </summary>

And is there any mean to find out more about the error and where it occurs?

(in this case I knew where it came from because I just had inserted the summary-comment).

Kind regards,
Peter

PS: I inadvertently posted this message first in the Welcome forum.
User avatar
robert
Posts: 4225
Joined: Fri Aug 21, 2015 10:57 am
Location: Netherlands

XS1569: Error writing to XML documentation file

Post by robert »

Peter,
With which version of X#?
I tried this with X# 2.10 and I do not see this error.

Robert

To elaborate:

Code: Select all

/// <summary>
/// test

CLASS XApp INHERIT App
/// <summary>
/// test
	METHOD Start()
END CLASS

produces the following comments in the generated XML file

Code: Select all

        <!-- Badly formed XML comment ignored for member "T:XApp" -->
        <!-- Badly formed XML comment ignored for member "M:XApp.Start(XSharp.__Usual[])" -->
XSharp Development Team
The Netherlands
robert@xsharp.eu
User avatar
pemo18
Posts: 72
Joined: Fri Apr 27, 2018 10:38 am
Location: Germany

XS1569: Error writing to XML documentation file

Post by pemo18 »

Hello Robert,

Its version 2.8.3.15 of XSharpCore.dll

I think is has something to do with a </summary> missing in a method comment below.

I will have to test this first and will report.

Regards,

Peter
User avatar
robert
Posts: 4225
Joined: Fri Aug 21, 2015 10:57 am
Location: Netherlands

XS1569: Error writing to XML documentation file

Post by robert »

Peter
We fixed some xml generation problems in 2.9 or 2.10 ( I don’t remember which build)

Robert
XSharp Development Team
The Netherlands
robert@xsharp.eu
User avatar
pemo18
Posts: 72
Joined: Fri Apr 27, 2018 10:38 am
Location: Germany

XS1569: Error writing to XML documentation file

Post by pemo18 »

Hello Robert,

Although I have a "wild mix" of classes in the project with regular comments (like /// <summary>) and other styles (only // without any offiical tag) the compiler usually never complains.

Its problably a mixture of several circumstances that results in a compiler error from time to time.

Kind regards,
Peter

PS: By the way - what about an X# conference this year;)
User avatar
robert
Posts: 4225
Joined: Fri Aug 21, 2015 10:57 am
Location: Netherlands

XS1569: Error writing to XML documentation file

Post by robert »

Peter,
pemo18 wrote: PS: By the way - what about an X# conference this year;)
We would love to do that. But given the Covid situation we want to wait a few more months before starting the preparations.

Robert
XSharp Development Team
The Netherlands
robert@xsharp.eu
User avatar
wriedmann
Posts: 3644
Joined: Mon Nov 02, 2015 5:07 pm
Location: Italy

XS1569: Error writing to XML documentation file

Post by wriedmann »

Hi Robert,
PMFJI, but:
But given the Covid situation we want to wait a few more months before starting the preparations.
in September most likely there will be no problems. They may start the earliest in October, if we look at the last two years.
So for an event in middle September we would have the best chances....
Wolfgang
Wolfgang Riedmann
Meran, South Tyrol, Italy
wolfgang@riedmann.it
https://www.riedmann.it - https://docs.xsharp.it
Post Reply