Delacor Toolkits Discussions

cancel
Showing results for 
Search instead for 
Did you mean: 

(DQMH) Documentation Generator

Highlighted

I found this :

Annotation 2019-09-10 102922.png

I don't know who "me" is...


We have two ears and one mouth so that we can listen twice as much as we speak.

Epictetus

Antoine Chalons

0 Kudos
Message 21 of 31
(947 Views)
Highlighted

While trying to use the method above, I found this easy way to get the icon + inputs / ouputs

Annotation 2019-09-10 112455.png


We have two ears and one mouth so that we can listen twice as much as we speak.

Epictetus

Antoine Chalons

Message 22 of 31
(935 Views)
Highlighted

Hi everyone,

here it is, if you want to give a try at the doc generator on your own project, source code can be found here --> https://gitlab.com/wovalab/open-source/labview-doc-generator/blob/master/Test%20Project/Doc/Project%...

 

Please be kind with this firs version, it’s an alpha Smiley Wink

You'll find documentation and information about the project in the readme file --> https://gitlab.com/wovalab/open-source/labview-doc-generator/blob/master/README.adoc

 

Code source is licensed as bsd3 --> https://choosealicense.com/licenses/bsd-3-clause/

 

Project is open source, so if you want to participate in its development, you're more than welcome. I wrote a simple contributing guidelines here --> https://gitlab.com/wovalab/open-source/labview-doc-generator/blob/master/CONTRIBUTING.adoc

 

After some discussions, I think that the project could/should handle other kind of project documentation like lvlib or lvclass, but the first goal is being able to document DQMH project.

 

There are a lot of things to do and I've been using issues Gitlab feature to gather them. Feel free to add your own requirement here --> https://gitlab.com/wovalab/open-source/labview-doc-generator/issues

 

The last thing I want to mention is that I have never been involved in any open source project development before this one, so feel free to advise me if you see that something needs to be improved on the open source development process.

 

Look forward to hearing from you 🙂

Olivier JOURDAN

Wovalab | Certified LabVIEW Architect | DQMH Trusted Advisor |
Message 23 of 31
(795 Views)
Highlighted

Hi there,

Just a bit of update on documentation generator.

 

In attachment, you'll find the pdf autolaticaly generated. This is still a work in progress, but it integrate two new "features":

  1. DQMH module sections now display a table containing the list of request callers
  2. The PDF generated is now customized with a theme

I hope to have a first public version to document DQMH project soon. 

Olivier JOURDAN

Wovalab | Certified LabVIEW Architect | DQMH Trusted Advisor |
Message 24 of 31
(534 Views)
Highlighted

Fantastic! Finally there will be a good docs provider with pdf output.

 

I've just spot only few small typographical things you may want to look into:

  • The table of content being "inlined" with first chapter - how about having it on separate page?
  • Sections and subsections are continuously starting - is it possible to start it from new page?
  • You have used a book layout - overhead section names and page numbers swap sides on even and odd pages
  • Is it some typo with most of API calls reering to Delacor QMH Project Template 4.0.0.47 and 4.2.1.6 at te same time?
></a>
Message 25 of 31
(435 Views)
Highlighted

@Mradziwo  a écrit :

Fantastic! Finally there will be a good docs provider with pdf output.

 

I've just spot only few small typographical things you may want to look into:

  • The table of content being "inlined" with first chapter - how about having it on separate page?
  • Sections and subsections are continuously starting - is it possible to start it from new page?
  • You have used a book layout - overhead section names and page numbers swap sides on even and odd pages
  • Is it some typo with most of API calls reering to Delacor QMH Project Template 4.0.0.47 and 4.2.1.6 at te same time?

Great to hear this feedback. I think that most of your points can be address. If you want to be notified of any progress on that don't hesitate to create issues in the gitlab project 😉

 

For the last point, doc generator just use VI description, so DQMH references are in the project.

Olivier JOURDAN

Wovalab | Certified LabVIEW Architect | DQMH Trusted Advisor |
Message 26 of 31
(412 Views)
Highlighted

I'm working on my first "big" project right now and was searching for some kind of tool like this. Thanks for the work you put into this! Are there some major features missing or is it already some kind of a complete tool?

0 Kudos
Message 27 of 31
(219 Views)
Highlighted

Almost one year ago now, but here is the first "real" public release !!!

 

https://www.linkedin.com/posts/jourdanolivier_first-public-beta-release-activity-6676888540112011264...

 

Feel free to report bug and comments directly in Gitlab --> https://gitlab.com/wovalab/open-source/labview-doc-generator

Olivier JOURDAN

Wovalab | Certified LabVIEW Architect | DQMH Trusted Advisor |
Message 28 of 31
(86 Views)
Highlighted

@Jens_S  a écrit :

I'm working on my first "big" project right now and was searching for some kind of tool like this. Thanks for the work you put into this! Are there some major features missing or is it already some kind of a complete tool?


Sorry, I missed your post 😞

 

The first beta is now released, but there a lot of feature missing 😛

Anyway, I'm sure that they will be added in the future 🙂

Olivier JOURDAN

Wovalab | Certified LabVIEW Architect | DQMH Trusted Advisor |
0 Kudos
Message 29 of 31
(84 Views)
Highlighted

Thanks for the info, I will take a look into it.

0 Kudos
Message 30 of 31
(57 Views)