{"id":19080411,"url":"https://github.com/seeminglyscience/psclasshelpexample","last_synced_at":"2025-07-25T22:38:45.440Z","repository":{"id":87373517,"uuid":"98038298","full_name":"SeeminglyScience/PSClassHelpExample","owner":"SeeminglyScience","description":"Example of existing support for classes in the PowerShell help system.","archived":false,"fork":false,"pushed_at":"2017-07-22T14:59:06.000Z","size":4,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-18T21:30:55.058Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SeeminglyScience.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-22T14:58:17.000Z","updated_at":"2024-07-27T17:58:10.000Z","dependencies_parsed_at":"2023-03-27T13:04:54.837Z","dependency_job_id":null,"html_url":"https://github.com/SeeminglyScience/PSClassHelpExample","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeminglyScience%2FPSClassHelpExample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeminglyScience%2FPSClassHelpExample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeminglyScience%2FPSClassHelpExample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeminglyScience%2FPSClassHelpExample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SeeminglyScience","download_url":"https://codeload.github.com/SeeminglyScience/PSClassHelpExample/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251651231,"owners_count":21621716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T02:23:31.755Z","updated_at":"2025-04-30T06:10:50.490Z","avatar_url":"https://github.com/SeeminglyScience.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PSClassHelpExample\n\nThis repo is a short example of native support for Classes in the PowerShell help system.\n\n## Description\n\nThe module included in this repository has a class and a external help file. The external help file contains all of the information from the class, including properties and methods. This file was created by hand, as far as I know there is no existing tool that will generate it.  It's important to note everything used in this example is there by default, I did not write anything that allowed this.  This is just **existing native help support for classes in 5.1**.\n\nI have not seen any other examples, documentation, or even mention of this existing, so I thought I'd share.\n\n## See for yourself\n\nClone the repo, add it to your `PSModulePath` (you could also clone directly into it) and get the help info.\n\n```powershell\ngit clone https://github.com/SeeminglyScience/PSClassHelpExample\n$env:PSModulePath += \";$pwd\\PSClassHelpExample\"\nGet-Help MyClass -Full\n```\n\nReturns the following help output.\n\n```txt\nNAME\n    MyClass\n\nSYNOPSIS\n    This is the synopsis of a test class.\n\nPROPERTIES\n    [String] $Test\n    This is a description of a test property.\n\n    [FileInfo] $SecondTest\n    This is another description of a different test property.\n\n\nMETHODS\n\n    [FileInfo] GetMyFile([string] $someValue)\n    This method gets the SecondTest property from this instance.\n\nEXAMPLES\n    -------------------------- EXAMPLE 1 ---------------------------\n    $myClass = [MyClass]::new()\n    $myClass.SecondTest = Get-Item .\\test.txt\n    $myClass.GetMyFile('Unused text')\n\n    Uses the useless test class.\nRELATED LINKS\n    Online Version: https://github.com/SeeminglyScience\n    System.IO.FileInfo: https://msdn.microsoft.com/en-us/library/system.io.fileinfo(v=vs.110).aspx\n\nREMARKS\n    To see the examples, type: \"get-help  -examples\".\n    For more information, type: \"get-help  -detailed\".\n    For technical information, type: \"get-help  -full\".\n    For online help, type: \"get-help  -online\"\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseeminglyscience%2Fpsclasshelpexample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseeminglyscience%2Fpsclasshelpexample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseeminglyscience%2Fpsclasshelpexample/lists"}