Check documentation seems to stop working after using it once

DocInsight
1

I just tried to clean up the existing issues in the spring4d xmldoc but hitting “Check documentation…” and then selecting “Project Group” seems to do nothing any further attempt after the first - on the first time I could see the dialog with the progress bar and then listing the existing issues in the message window - but any subsequent runs nothing happens and it still lists that latest but already resolved issues.

Closing and reopening the project group seems to make it work again - for one attempt. After that it stops again.

Just found the “Restart the DocInsight Server” option and that one also makes it work for one attempt. I send you the server log via email.

2

Thanks for your report! I should have addressed the issue - It is a naive bug: the Check Doc action doesn’t clear the messages group when returned diagnostics are empty so that the messages will be left in the group when you resolved them.

Fixed now. It will clear the messages and show:

The XML documentation check is complete with no issues detected.

3

btw. there will be more checking:

  • cref in see/seealso/exception tags
  • file path in img/see/seealso tags
  • parameter names
  • paramref
  • …

it should be also useful to consider some simple fixes, a very common error likes “TArray” in xml doc comments.