Search the Community

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 class The private data also has its own table that looks like 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. Enjoy!

Component_Builder_5_31_2018.zipIN PROGRESS!!! Overview At Cirrus Logic, I'm responsible for creating applications and frameworks to improve the efficiency of our validation department and ultimately lower the cost of validation. In order to quickly and efficiently turn source into applications and frameworks for distribution, a build system was necessary to abstract away the conversion of source into the different types of deliverables (VIPackages, Executables, dlls, ect) consumed by my end users, as well as abstract away the build order of our hierarchical reuse libraries that are used across applications and frameworks. 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. Description At NIWeek 2018 I gave a presentation on the build system. You can find the pdf of the presentation here: https://event.crowdcompass.com/niweek2018/activity/rQM8g1QHz2 and I've attached the PDF of the presentation below. 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 Assumptions Source Organization Other Assumptions Application Architecture Extension Software Requirements LabVIEW 2014 LabVIEW Container AQ Character Lineator Steps to Implement or Execute Code Additional Information or References Component_Builder_10_11_2018.zip Component_Builder_5_31_2018.zip Build UI Demo.mp4 Save Time by Building Your Source With Build Abstraction Layers.pdf