{"id":18723321,"url":"https://github.com/kedyn/simpledocumentation","last_synced_at":"2026-01-29T07:38:43.884Z","repository":{"id":105911114,"uuid":"140034826","full_name":"Kedyn/SimpleDocumentation","owner":"Kedyn","description":"Generates documentation based on comments on an mSL file.","archived":false,"fork":false,"pushed_at":"2018-07-09T09:45:20.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-11T06:02:43.004Z","etag":null,"topics":["documentation-generator","mirc","tool"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kedyn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2018-07-06T22:24:45.000Z","updated_at":"2021-05-22T15:40:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"c2b3d80e-2c00-4cfb-b523-950c347eeb9f","html_url":"https://github.com/Kedyn/SimpleDocumentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Kedyn/SimpleDocumentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kedyn%2FSimpleDocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kedyn%2FSimpleDocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kedyn%2FSimpleDocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kedyn%2FSimpleDocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kedyn","download_url":"https://codeload.github.com/Kedyn/SimpleDocumentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kedyn%2FSimpleDocumentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28870638,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T07:35:32.468Z","status":"ssl_error","status_checked_at":"2026-01-29T07:33:31.463Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation-generator","mirc","tool"],"created_at":"2024-11-07T13:48:25.974Z","updated_at":"2026-01-29T07:38:43.870Z","avatar_url":"https://github.com/Kedyn.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SimpleDocumentation\nThis is a tool that generates documentation based on comments on an mSL file.\n\n# Dependencies\n\nmIRC v7.52+\n\n# Installation\n\nThe main file is called `SimpleDocumentation.mRC` and it is located in the `root` folder. \n\n# How to use it\n\nThe main command is `document \u003cfile\u003e \u003cdestination\u003e`, where `\u003cfile\u003e` is the msl file and `\u003cpath\u003e` the destination path for the file of the documentation *(README.html)*.\n\nAll of your documentation comments must start with **`/**`**. And the documentation must start with an asterics and a space (`* `). The documentation must follow the following paterns:\n\n**For General Information**\n```php\n/**\n* @title Documentation title\n* @header Main Header\n* @subheader Sub Header\n* @footer Some footer\n*/\n```\n*example:*\n```php\n/**\n* @title My Project's Documentation\n* @header My Project\n* @subheader The best project\n* @footer My Project\n*/\n```\n\n**For events:**\n```php\n/**\n* Description...\n*\n* @event someEvent\n*/\n```\n*example:*\n```php\n/**\n*\n* Loads everything needed for this project when mIRC starts.\n*\n* @event start\n*\n*/\non *:start: echo -s nothing is needed ;)\n```\n\n**For Commands**\n```php\n/**\n* Description...\n*\n* @command /myCommand\n*\n* @switch a some description...\n* \n* @param \u003csomeParam\u003e someParam description...\n*\n* @global\n*/\n```\n*example:*\n```php\n/**\n*\n* Changes my nick to something random\n*\n* @command /fun\n*\n* @param \u003cN\u003e the number of characters\n*\n*/\nalias -l fun {\n  var %nick = $char($rand(65,90)),%i = 1\n  whie (%i \u003c $1) {\n    %nick = $+(%nick,$char($rand(65,90)))\n    inc %i\n  }\n  nick %nick\n}\n```\n\n**For Identifiers**\n```php\n/**\n* Description...\n*\n* @identifier $myIdentifier\n* \n* @param \u003csomeParam\u003e someParam description...\n*\n* @prop someProp someProp description...\n*\n* @global\n*/\n```\n\n*example:*\n```php\n/**\n*\n* Returns my projects current version.\n*\n* @identifier $SIMPLE_VERSION\n*\n* @global\n*\n*/\nalias SIMPLE_VERSION return 0.0.1\n```\n\n__*Note:*__\n- All *@* specifiers are optional.\n- *@title*,*@header*,*@subtitle* can only be one line long\n- The *@global* specifier indicates that the alias is a global.\n\n# Contributing \u0026 Development Process\n\nIf you would like to contribute to the project I ask that you use variable_names with all lower case and all aliases with camelCase. All new aliases and/or modifications must be documented.\n\n# License\n\nThis project is made available under the MIT License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkedyn%2Fsimpledocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkedyn%2Fsimpledocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkedyn%2Fsimpledocumentation/lists"}