Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request addresses an initial setup to start generating documentation for all classes. The end goal of the doc generator:
Note
The static methods came from the idea on the DSC discussion by Mikey. This is far from crystalized, but an attempt to kickstart the idea for resource authors in this repository.
I talked with Jim Truher also on class documentation, but there isn't anything available (yet). In the current commit, you can also see the attempt to dynamically generate docs using the
Microsoft.PowerShell.PlatyPS
module. However, there are to many properties outputted when converting for Markdown. That's why I choose the way to build it up using separate functions.Microsoft Reviewers: Open in CodeFlow