Need a help run to DscResource.DocGenerator in powershell

[selvanayaki678]

Please guide me to run this tool against my DSC script and get documentation for my code.

I have a DSC script with me, and I want to get documentation for that. I'm not able to figure out the syntax in PowerShell.

I need assistance for that.

Thanks in advance.

[selvanayaki678]

@johlju and @gaelcolas Please help me on the above query

[johlju]

I'm assuming you mean a DSC script as in DSC resource code and not DSC configuration script, the later cannot be documented with this module. This module have Invoke-Build tasks that are meant to be used together with a repository that is using a build pipeline based on the Sampler project. These tasks assumes that code and supporting files are in certain places and is built in the pipeline. There are public functions in this module but they were not really planned to be used outside of the tasks but they can, but it assumes a lot about file paths and code that is not documented. You probably need to look at the code to see how to use it.

If you want to document a module containing DSC resources then you should first setup a module project using the Sampler project. Use the dsccommunity template with Sampler. When that builds correctly then you can look at the README in this repository too see how you add the additional tasks to your modules build pipeline.