{"id":17024133,"url":"https://github.com/cyevgeniy/pldoc","last_synced_at":"2025-09-17T23:11:11.477Z","repository":{"id":107737229,"uuid":"499953506","full_name":"cyevgeniy/pldoc","owner":"cyevgeniy","description":"Documentation generator for Oracle PL/SQL","archived":false,"fork":false,"pushed_at":"2025-05-17T13:06:45.000Z","size":56,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-17T13:51:16.367Z","etag":null,"topics":["pl-sql","plsql","plsql-docs","plsql-documentation"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyevgeniy.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,"zenodo":null}},"created_at":"2022-06-04T22:55:43.000Z","updated_at":"2025-05-17T13:06:48.000Z","dependencies_parsed_at":"2024-05-04T07:22:30.826Z","dependency_job_id":"2ac40127-f96d-4d24-8f74-1efe4f356b9d","html_url":"https://github.com/cyevgeniy/pldoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cyevgeniy/pldoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyevgeniy%2Fpldoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyevgeniy%2Fpldoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyevgeniy%2Fpldoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyevgeniy%2Fpldoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyevgeniy","download_url":"https://codeload.github.com/cyevgeniy/pldoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyevgeniy%2Fpldoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275680447,"owners_count":25508570,"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","status":"online","status_checked_at":"2025-09-17T02:00:09.119Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["pl-sql","plsql","plsql-docs","plsql-documentation"],"created_at":"2024-10-14T07:24:35.997Z","updated_at":"2025-09-17T23:11:11.430Z","avatar_url":"https://github.com/cyevgeniy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pldoc -  documentation generator for PL/SQL\n\n## Demo\n\nThis is the [generated documentation](https://ychbn.com/pldoc-docs/amazon_aws_s3_pkg.html)\nfor the [Alexandria plsql utils library](https://github.com/mortenbra/alexandria-plsql-utils).\n\n\n**Note**: pldoc is under development.\n\n\n\nPldoc is a documentation generator for PL/SQL that is inspired by how documentation\nis generated in the Go programming language. It takes source code of specification files for\nPL/SQL packages and generates documentation in html format. Generated documentation can\nbe placed on a server or viewed locally. The source of documentation is the comments in\ncode. The comment that hasn't empty lines between itself and a code object (function, variable etc)\nis considered as the object's documentation. For example, the next code snippet is\nthe function `has_permission` with its documentation:\n\n```\n-- Returns true if the user has access to perform\n-- this operation.\nfunction has_permission(user_id number, op varchar2) return boolean;\n```\n\nIf there is a blank line (or lines) between a comment and an object, the comment\nisn't processed as documentation:\n\n```\n-- Returns true if the user has access to perform\n-- this operation.\n\nfunction has_permission(user_id number, op varchar2) return boolean;\n```\n\nHowever, an empty line (or lines) that is the part of a comment, isn't taken into account\nas a separator between documentation and an object and a whole comment\nis parsed as documentation:\n\n```\n-- Returns true if the user has access to perform\n-- this operation.\n--\nfunction has_permission(user_id number, op varchar2) return boolean;\n```\n\nFor now, pldoc can generate docs for:\n\n- Package documentation\n- Functions, procedures\n- Cursors\n- Records declaration\n- Varrays, tables\n- Constants and variables\n \n## Limitations\n\n- Specification files should be in UTF-8 encoding\n\n## Build from source\n```\ngo build pldoc.go\n```\n\n## Usage\n\nThis command generates documentation for each file with `.pks` extension\nin the `source_directory`. The documentation files will be placed in the\n`documentation` directory. \n```\npldoc --output=documentation source_directory\n```\n\nTo change the extension of searched files, `ext` flag is used:\n\n```\npldoc --output=documentation --ext=sql source_directory\n```\n\nPldoc can generate docs from multiple directories, all you need is just list them with a space. Each\ndirectory will be walked recursively, for example:\n\n```\npldoc --output=documentation source_dir1 source_dir2 source_dir3\n```\n## Comment styles\n\nIt's better not to decorate you comments. Bad example:\n\n```\n/*****************************************\n* This function returns the my_table row\n* by its id\n*****************************************/\n```\n\nGood example:\n\n```\n-- This function returns the my_table row\n-- by its id\n```\n\nAnother one good example:\n\n```\n/*\n   This function returns the my_table row\n   by its id\n*/\n```\n\n## Preformatted text and lists\n\nAny line that has greater indentation that comment's first line\nis preformatted text.\n\n```\n-- This procedure returns formatted output of\n-- passed record. It looks like this:\n--     key1: value 1\n--     key2: value 2\n--     key3: value 3\n```\n\nIn documentation, lines from 3 to 5 will be enclosed in\n`pre` tag.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyevgeniy%2Fpldoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyevgeniy%2Fpldoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyevgeniy%2Fpldoc/lists"}