DQMH Consortium Toolkits Discussions

cancel
Showing results for 
Search instead for 
Did you mean: 

Antidoc Add-on: LabVIEW project documentation; custom errors are not generated correctly

Solved!
Go to solution

Hello,

 

I wanna use custom errors in a DQMH-Modul and later generate the documenation by using Antidoc Add-on: LabVIEW project documentation.

Sadly somehow in the generated documenttation the error code and decription is missing.

 

Custom error in project (with naming *--error.vi) 

CustomError-in-DQMH-Modul.png

 

The error VI

CustomError-VI.png

 

Here the documenation

CustomError-Documenation.png

Also the documentation of "Module Not running" and "Request and..." is not complete.

 

Hast anyone the same problems? Must I configure something in the toolkit?

 

0 Kudos
Message 1 of 15
(672 Views)

Hi @-Helmut-,

First, a traditional question: can you check that you're using the latest add-on versions?

 

Antidoc should be able to retrieve the error number and the string constant's content for all the error vi style described here. Your screenshot seems to show a code supported by the addon.

 


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn

Stop writing your LabVIEW code documentation, use Antidoc!
0 Kudos
Message 2 of 15
(648 Views)

Hi Olivier,

 

thanks for your quick response 😊

 

I checked the versions, should be ok, no updates availlable, see below

 

PackageVersion.png

At the moment I´m using LabVIEW 2024Q3 64 Bit.

Before I also uploaded the demo project, it would be intersting it it works on your machine
Or have you a small demo were the generating of the documenation works? 

 

Helmut

 

0 Kudos
Message 3 of 15
(631 Views)

Screenshot 2026-05-06 at 00.51.41.png

 

😞

 

Olivier I could swear this has been working previously.




DSH Pragmatic Software Development Workshops (Fab, Steve, Brian and me)
Release Automation Tools for LabVIEW (CI/CD integration with LabVIEW)
HSE Discord Server (Discuss our free and commercial tools and services)
DQMH® (Developer Experience that makes you smile )


0 Kudos
Message 4 of 15
(618 Views)

That's weird!

I have a unit test to check all the code expected to generate content, and it works.

The truth is out there 😐 

 

OlivierJOURDAN_0-1778070481153.png

 


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn

Stop writing your LabVIEW code documentation, use Antidoc!
0 Kudos
Message 5 of 15
(596 Views)

@-Helmut- @joerg.hampel,

How did you create your error VIs?

From scratch or starting with a copy of an existing one? 


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn

Stop writing your LabVIEW code documentation, use Antidoc!
0 Kudos
Message 6 of 15
(594 Views)

Hi Olivier,

 

I think I copied a working one like "Module Not Stopped--error.vi".

But also generated errors from DQHM like "Module Not Running--error.vi" are not correct.

0 Kudos
Message 7 of 15
(586 Views)

It seems that I have a reproduction case

OlivierJOURDAN_0-1778071593872.png

Can you confirm that the issue is selective? Just a part of your error VI is not working? 


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn

Stop writing your LabVIEW code documentation, use Antidoc!
0 Kudos
Message 8 of 15
(584 Views)

Yes it looks the same!

Error code = 0 and missing description

0 Kudos
Message 9 of 15
(574 Views)

Ok, I think I found the bug.

The issue should happen only on the error VIs containing the `Error Cluster From Error Code.vi` and one or more VIs.

I have to make the parsing code more robust.

 

@-Helmut-, may I ask you to create an issue in the Antidoc addon project?


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn

Stop writing your LabVIEW code documentation, use Antidoc!
0 Kudos
Message 10 of 15
(564 Views)