Jump to content

LabVIEW APIs For Confluence \ JIRA and an Auto Documentation API For LabVIEW Classes

Recommended Posts

Have you ever needed to programmatically generate a report documenting your LabVIEW Classes? I've released an alpha version of my auto-documentation utility I designed and implemented at Cirrus Logic (http://bit.ly/ChrisCilino_AutoDoc).

I designed and created the software in 4 parts. 1) An Atlassian Confluence API, 2) An Atlassian JIRA API, 3) A Class Report generation API, and 4) Two very small "applications" the demonstrate the API's usage. Not only can the APIs \ examples document your code, you can also generate JIRA tickets for the parts of your documentation you're missing.

I hope you'll find this software as useful as we at Cirrus Logic have. I would consider it "mid alpha" quality, but intend on investing in it over time. You can find the software at http://bit.ly/ChrisCilino_AutoDoc

Here's an example of a generated report for the members of a class718x203.png

The private data also has its own table that looks like751x257.png


There are many more features to the report, not to mention the APIs used to generate the reports. Also I've created an application to generate JIRA tickets that list the missing parts of a report.




  • Like 2
Link to comment

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Similar Content

    • By Chris Cilino
      In order to quickly and efficiently prepare source for distribution, a build system was necessary to abstract away the conversion of source into the different types of deliverables (VIPackages, Executables, dlls, ect) as well as abstract away the build order of our software hierarchy.
      Many have undertaken to solve this problem. I don't claim to have created a silver bullet. But I do hope that the system I've put together (and am releasing as open source) will act as a starting point for you to extend and customize to meet your needs. I've endeavored to employ good software development principles including separation of concerns, and the SMoRES principles.
      I'll be the first to volunteer that it isn't perfect and as always, our best software is constantly a work in progress. However, I believe the build system is at a stage to be at least moderately helpful to a handful of people in our community. 
      The Application's UI
      The UI is designed to guide someone through the build process, allowing them to select what components or exports they would like to build, if and how they would like to be notified about the build, auto submission options, and source code control. I've attached a small video titled "Build UI Demo.mp4" below.
      UML and APIs
      All UML and API documentation are included in the Word document per released zip file
      Software Requirements
      LabVIEW 2017
      NI Application Builder
      VI Package Manager Pro
      Other dependencies are listed in the Instructions per zip file.
      UML Overview
      As of 1.4.0-58 the UML looks like:

      Build UI Demo.mp4
      Release Notes
      1.4.0-123 (Component Builder 1.4.0-123.zip)
      Added new NI Package Manager API Added new NI Package Manager BuildSpec Utils  Added procedure and documentation for the component template and its anatomy  
      1.4.0-113 (Component Builder 1.4.0-113.zip)
      Added documentation for the SCC API  
      1.4.0-111 (Component Builder 1.4.0-111.zip)
      1.4.0-99 (Component Builder 1.4.0-99.zip)
      Added a few new P4 API functions allowing the creation of a session if a user is already logged it.  Added Log in and log out tests to the test suite.  Adding new function to tag all p4 paths in a label with the label. Resolving the input path to a p4 depot path Adding quotes around p4 paths.
      1.4.0-91 (Component Builder 1.4.0-91.zip)
      The refactor of the LabVIEW SCC API is complete and the build process is linked to the new install location. The LabVIEW SCC API can now be used independently of the Component Build process.  I've included a test suite for the P4 implementation of the SCC API. It assumes that you have checked in the two files in the "Build Instructions\LabVIEW SCC API\Test Suite\Tests\Test Dir" into perforce.  
      1.4.0-85 (Component Builder 1.4.0-85.zip)
      This is a major refactor in the SCC API. I've modeled the p4 label with a new api. This release is primarily as an intermediary release. I intend on breaking SCC out of the component builder into its own separate component in the next release. 1.4.0-81 (Component Builder 1.4.0-81.zip)
      Created a "proxy" api for VI Package manager interactions. Sometimes the VI Package manager api would hang. So I now call by reference and will kill and restart VIPM if it doesn't respond in time.   
      1.4.0-75 (Component Builder 1.4.0-75.zip )
      Fixed reference counting for executable builds.   
      1.4.0-73 (Component Builder 1.4.0-73.zip)
      In the case where a user has specifically unchecked "auto increment", the build process will auto increment the build. Builds must be auto incremented.  I've released a new build of the container that has a minor bug fix. Added file utility tools to aid with using "net use" to move and copy files across the network.  
      1.4.0-59 (Component Builder 1.4.0-59.zip)
      Minor spelling error in component template: "componet". Added documentation for the Custom Install Step Launcher. Added build instructions for Custom Install Step Launcher.  
      1.4.0-58 (Component_Builder_1.4.0-58.zip)
      Added the ability to export NI-Source Distributions, NI-Executables, NI-Insatllers, and NSIS Installers Released a template component that exports an NI Package and VI Package including step by step instructions Released "Custom Install Step Launcher" to execute VIs as pre install, post install and post install all actions for NI Packages. Released comprehensive documentation included in the zip file. Component_Builder_5_31_2018.zip
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.