DQMH Consortium Toolkits Discussions

cancel
Showing results for 
Search instead for 
Did you mean: 

(DQMH) Documentation Generator

Solved!
Go to solution

We just put Antidoc through a project with 22 DQMH modules, 40 libraries, and it generated successfully a 419 pages document.

 

The most important part is that the tables would be very useful during troubleshooting because I can see where all the requests are called and where the code registers for broadcasts.

 

Excellent work Olivier!

 

Thanks,

Fab

For an opportunity to learn from experienced developers / entrepeneurs (Steve, Joerg, and Brian amongst them):
Check out DSH Pragmatic Software Development Workshop!

DQMH Lead Architect * DQMH Trusted Advisor * Certified LabVIEW Architect * Certified LabVIEW Embedded Developer * Certified Professional Instructor * LabVIEW Champion * Code Janitor

Have you been nice to future you?
Message 31 of 40
(2,758 Views)

V1.0 has been released yesterday --> https://wovalab.gitlab.io/open-source/labview-doc-generator/posts/2020-07-15-v-1.0-release/

 

Enjoy!


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn |

Stop writing your LabVIEW code documentation, use Antidoc!
Message 32 of 40
(2,723 Views)

The architecture graphs are super useful, thanks for this great tool 😉.

Message 33 of 40
(2,719 Views)

Version 1.2.0 is available on vipm.io --> more info here https://www.linkedin.com/feed/update/urn:li:activity:6754688226461569024/


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn |

Stop writing your LabVIEW code documentation, use Antidoc!
Message 34 of 40
(2,536 Views)

When I use the browser with the plugins enabled, I am able to see the UML diagrams.

 

but when I export to pdf, I just see the same text in the pdf as I do in the adoc format.

 

is there a trick  to getting the uml diagrams into the pdf?

 

EDIT:  If I use AsciiDoctor to create the PDf, I do not see the UML diagrams.   If I use Chrome to view the HTML page (with the extensions enabled), I can use the built in Microsoft Print to PDF to get the UML diagrams, but you lose the ability of clicking on the table of contents to jump to a section like you have in the HTML.

Kenny

0 Kudos
Message 35 of 40
(2,506 Views)

Hi Kenny,

First of all, I would say that to obtain a full-featured PDF; the only way is to use the asciidocotor toolchain. So the right question is why you don't get the UML diagram when you use Asciidoctor.

 

Question: did use the following command to generate your pdf?

 

asciidoctor-pdf -r asciidoctor-diagram myfile.adoc

 

This should work.


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn |

Stop writing your LabVIEW code documentation, use Antidoc!
0 Kudos
Message 36 of 40
(2,493 Views)

For the record, version 1.2.1 is available on vipm.io. More information here --> https://wovalab.gitlab.io/open-source/labview-doc-generator/posts/2021-02-16-v-1.2.1-release/


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn |

Stop writing your LabVIEW code documentation, use Antidoc!
0 Kudos
Message 37 of 40
(2,484 Views)

Ah, ok, thanks for the help on the command.

 

I had tried running 

asciidoctor-pdf basic-example.adoc

 

from the asciidoctor webpage. 

Kenny

0 Kudos
Message 38 of 40
(2,478 Views)
Solution
Accepted by Olivier-JOURDAN

Some heads-up about Antidoc:

 

  1. New version 1.2.2 is available. As DQMH user you are more than encouraged to update because it fixes bugs related to DQMH modules parsing
  2. I created a LinkedIn page dedicated to Antidoc. I encourage you to follow this page to be aware of any news related to Antidoc --> https://www.linkedin.com/showcase/antidoc---the-cure-to-your-labview-project-documentation
  3. If you have any issue or feature request create an issue directly in the GitLab project --> https://gitlab.com/wovalab/open-source/labview-doc-generator

Thanks,

 

Olivier


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn |

Stop writing your LabVIEW code documentation, use Antidoc!
Message 39 of 40
(2,167 Views)

I'm adding another channel for those who will be interested in discussing the Antidoc project in a more casual/direct way --> https://wovalab-open-source-projects.zulipchat.com/#


Olivier Jourdan

Wovalab founder | DQMH Consortium board member | LinkedIn |

Stop writing your LabVIEW code documentation, use Antidoc!
Message 40 of 40
(1,348 Views)