Antidoc

Here is the second major version of Antidoc.

This is a significant rewriting that brings two major features:

Generation of the PDF/HTML5 output

Until there, Antidoc was generating a plain text file you’d need to render in a more readable format through a web extension or after installing the Asciidoctor toolchain manually.

You can now choose to generate the PDF or the HTML version of the documentation at the end of the generation process.

Add-on’s mechanism

Antidoc now supports document-type add-ons. That means that anyone can create their type of document!

An add-on can implement its own:

• user configuration window
• parsing process
• document composition

Antidoc handles the configuration recording and the document generation.

This new version is fixing a bug that can prevent you to get the documentation generated. See the release note for more details.

Antidoc v1.2.3

The package is directly available through VI Package Manager.

Release note

Bug fix

• Error 1099 when parsing project –> #162
• Too much “…” in the menu item –> #165

This new version is mainly for DQMH framework users. The main fixes improve the reliability of DQMH module relationship parsing.

We also improve the readability of requests/broadcasts tables generated by removing useless information and sorting items in alphabetical order.

Antidoc v1.2.2

The package is directly available through VI Package Manager.

Release note

Bug fix

• Filtering of libraries by name not applied when using the API –> #125
• Typo in progress bar text –> #126
• Modules Overview diagram doesn’t show all of the broadcast/request arrows –> #134
• Some tables were empty –> #135
• Disabling the List Default DQMH Events option does not work –> #147
• Show correct current legal information of DQMH –> #159
• lvlibs containing DQMH modules show as separate DQMH modules –> #160

This new version is mainly a maintainance release, but it also brings you support for LabVIEW 2020 interfaces.

Important note: Antidoc CLI needs to be updated to be compatible with this version

Antidoc v1.2.1

The package is directly available through VI Package Manager.

Release note

New features

• Handle LabVIEW interfaces –> #117

Changes

• Better integration of progress bar API –> #99 and #100
• Icons replace event types string in DQMH event table –> #104
• Change UML Class diagram orientation –> #124

Bug fix

• Add reference to classy Diagram Viewer in Legal Information section –> #97
• Add config object input to all public VIs using the config –> #98
• Lib filtering not correctly apply on callers –> #101
• Wrong menu item name –> #102
• Error during UML generation due to interfaces –> #116
• Progress bar refresh for multi-target project –> #118
• Empty section displayed –> #119
• Missing item in library –> #123

This new version brings you lots of improvements and is going to interest LabVIEW developpers who are not using DQMH(T)framework. If you don’t want to read the change log, here is a sumary of what you get with this new version:

• UML Class diagram representation
• DQMH custom error listing
• Multi-target support
• A much better way to display information in the final document ; more useful content in less pages

Special thanks to Tatiana Boyé who contributed on the UML class diagram feature with her tool, classy Diagram Viewer.

Important note: Antidoc CLI needs to be updated to be compatible with this version

We also know that some of LabVIEW devs are expecting more from Antidoc. Unfortunately, this version is not going to bring you the following stuff yet:

• Specific AF parsing
• Support for any kind of referenced class
• Lots of awesome features we have in mind but didn’t develop yet

This new version brings you the latest part to fully automate your doc generation, the Antidoc CLI tool. With it, you will add the document generation as part of your CI/CD setup.

This version is also the opportunity to continue to improve Antidoc. Among the different modification we made, we want to point you the following:

• Extended character set is now supported with the last version of Asciidoc toolkit for LabVIEW
• Tool GUI displays a progress bar that gives you information on the task running during the document generation process
• There is an option to ask Antidoc to parse libraries contained in the project dependencies

Here it is! We are glad to announce the release of the first official version of Antidoc.

We are firmly convinced that Antidoc will help you get a valuable and up to date documentation for your LabVIEW project.

Even if we want this tool to be useful to most LabVIEW developers, this first version addresses, mainly DQMH(R) framework users. That said, what works for DQMH(R) will work in the future for other frameworks.

What will you get with Antidoc?

Beautiful DQMH(R) relationship modules graph

This graph shows the different DQMH modules used in your project and how they share data using Requests and Broadcasts.

We are happy to release the first public beta version of the tool.

Even if we know that many things are missing and bugs are obviously existing in this beta, we would like to let you know about the tool and the way it works.

Goal

Use LabVIEW content to generate valuable documentation that wil help maintain your projects and onboard new resources in the development team.

When we say “LabVIEW content” we not only speak about vi description, we also speak about how the different part of the code are linked together.

As a DQMH user, the tool has been primarily developed to get most information from this framework. We hope to support OPP and other frameworks in the future.

How to

You can generate the documentation of your LabVIEW project running the tool from Tools»Wovalab»AntiDoc»Generate Project Documentation… menu item.

After minimal configuration (1-Select the lvproj you want to document ; 2-Fill in document title, author name and e-mail address), you just have to hit the Generate documentation button (3).