Sign Up
VIPM › Posts › Can AntiDoc help me document a simple library toolkit?

suggestion

Can AntiDoc help me document a simple library toolkit?

Suggestion shared 2 years, 8 months ago by Jim Kring
Related Packages: AntiDoc
   

Details

I have a toolkit that I would like to create some nice documentation for:

https://www.vipm.io/package/vipm_lib_labview_collection_extensions/

Can AntiDoc help me with this?

It seems to me that AntiDoc is currently good at documenting component interactions for projects using frameworks like DQMH, etc.

However, it's mission statement is "Tool for automatic lvproj documentation generation" -- does a simple reuse library count? :)

Thanks for this great tool!

Comments

Wovalab This is definitely a use case Antidoc should be able to handle! Thank you for the idea, Jim.
  1
 •  Reply • 2 years
Jim Kring You're very welcome! Let me know if you ever need any other feedback or testing. It would be great to standardize the open source tools community on AntiDoc :)
 •  Reply • 2 years
Olivier Jourdan Jim, I created an issue on the GitLab project. I detailed what could be the first version of this new feature --> https://gitlab.com/wovalab/open-source/labview-doc-generator/-/issues/166 Let me know if you think that would cover your idea. I don't know when I'd be able to work on it, but I'm pretty confident that there is no technical issue to make this work with Antidoc.
 •  Reply • 2 years
Jim Kring Thanks! That looks like a great start.
 •  Reply • 2 years
 •  Reply • 2 years

Please sign in to leave a comment.