Scaffold Out Reference Docs for Classes

[michaeltlombardi]

We probably should have the class reference docs cover:

• Namespace
• Inheritance Hierarchy
• Syntax
• Constructors
• Properties
• Methods
• Examples

PlatyPS doesn't (yet) have a way to generate reference documentation for PowerShell classes, so we'll need to work something out for this. The work for the event viewer class currently pulls mainly from the reference documentation layout for a function, rather than a class.

For an example of class documentation from MSDN, see the ScheduledJobDefinition class.

[MSAdministrator]

Thanks for this! I believe someone (maybe KevMar) created a port of PlatyPS to include Classes. I'll have to review and incorporate possibly if it's publicly available.

[michaeltlombardi]

If that exists, we need it in the mainline project, because it's a painful thing to have to address manually for each class for every module.

[MSAdministrator]

@michaeltlombardi question for you if you don't mind. I have added documentation to "documentation" branch in the following locations:

• docs/reference/classes/LogFile.md
• docs/reference/classes/WriteHost.md
• docs/reference/classes/EventViewer.md (modified)

I'm not sure exactly what I should add to these locations:

• docs/reference/classes/readme.md
• docs/reference/readme.md
• docs/narrative/readme.md
• docs/concept/readme.md

Do you have a reference or link that I could use to create said documentation?

Thanks again for your help!

[michaeltlombardi]

Sorry for not responding sooner - those are what you can think of as section-index pages. There's nothing super valuable in them by default (gitbook does weird things if you forget to scaffold out readmes for a chapter), but you can update them with things like:

• TOC for the upcoming docs, or links to them. This is particularly useful when viewed from PDF rather than web format.
• Brief synopsis for each upcoming doc in the case of narrative/concept
• Links to external resources, like blog posts, videos, etc which touch on the topics but aren't directly in the docs

You can also leave them pretty barebones, most people won't invest huge effort into them.

Looking at the uploaded class docs now!