Problem Copy Ressource

DocInsight
1

I generate the HTML documentation using Jenkins CI.
For no apparent reason (no changes to the job script, no version replacement), I now get the following error:
“Error: Failed to copy file from C:\Jenkins_CI\workspace\Delphi\TiComInlineDoku\Ticom\PPS\PA\themes/legacy/images/note.png to \192.168.135.9\docinsight\Ticom\resources\note.png.”

Is this problem known, and do you have a solution for it?

Here is the script:

C:\Jenkins_CI\workspace\Delphi\InlineDoku>cd “C:\Entwicklung\DocInsight\bin”

C:\Entwicklung\DocInsight\bin>IF “false” EQU “true”
(
DocInsight.exe check -q -j2 --log-file “C:\Jenkins_CI\workspace\Delphi\InlineDoku\Output_HTML.log” --log-level “error” --manifest-path “C:\Jenkins_CI\workspace\Delphi\InlineDoku\HTML.diproj”
) else (
DocInsight.exe build -q -j4 --log-file “C:\Jenkins_CI\workspace\Delphi\InlineDoku\Output_HTML.log” --log-level “error” --manifest-path “C:\Jenkins_CI\workspace\Delphi\InlineDoku\HTML.diproj”
)
Error: Failed to copy file from C:\Jenkins_CI\workspace\Delphi\TiComInlineDoku\Ticom\PPS\PA\themes/legacy/images/note.png to C:\Output\resources\note.png.

Caused by:
Das System kann den angegebenen Pfad nicht finden. (os error 3)

C:\Entwicklung\DocInsight\bin>exit 1

2

Hi,

I tried a few cases. It seems that DocInsight failed to copy an image file collected from an <img> tag in XML doc comments. Could you please search for note.png in your code base first? (Although it looks like a DocInsight bug – it might be.)

In addition, we will improve the design so it does not abort when copying resource files fails. It should be also helpful to add more context information (e.g. source location of the user resource) if this is the case.

3

Follow-up:

We addressed the root cause when @TElmers sent some screenshots.

For some reason, the Doc Inspector editor did not produce a correct xml doc comment (<note type="note">...</note>) when editing a note. Instead, it copies the unrecognized html table into the generated xml doc.

/// ...
/// <input type="hidden" class="note" value="note" tabindex="-1">
/// <table>
/// <tbody>
/// <tr>
/// <th>
/// <img src="themes/legacy/images/note.png" class="note" title="Note">
/// <span class="note">Note</span>
/// </th>
/// ...

This caused the DocInsight CLI abort.

We will enhance error handling and introduce provenance information in future releases.