{"id":38499329,"url":"https://github.com/rdkcentral/hal-doxygen","last_synced_at":"2026-01-17T05:57:58.015Z","repository":{"id":176959775,"uuid":"610712740","full_name":"rdkcentral/hal-doxygen","owner":"rdkcentral","description":"RDK Hardware Abstraction Layer common doxgen build and configuration","archived":false,"fork":false,"pushed_at":"2025-10-03T15:50:21.000Z","size":125,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-10-03T16:35:53.986Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rdkcentral.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","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,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-03-07T10:30:06.000Z","updated_at":"2025-10-03T12:01:06.000Z","dependencies_parsed_at":"2024-02-23T15:43:45.133Z","dependency_job_id":"d80c13c0-58c4-42f8-9125-e2548b0adea5","html_url":"https://github.com/rdkcentral/hal-doxygen","commit_stats":null,"previous_names":["rdkcentral/hal-doxygen"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/rdkcentral/hal-doxygen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Fhal-doxygen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Fhal-doxygen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Fhal-doxygen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Fhal-doxygen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rdkcentral","download_url":"https://codeload.github.com/rdkcentral/hal-doxygen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Fhal-doxygen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28501351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T04:31:57.058Z","status":"ssl_error","status_checked_at":"2026-01-17T04:31:45.816Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":[],"created_at":"2026-01-17T05:57:57.317Z","updated_at":"2026-01-17T05:57:57.996Z","avatar_url":"https://github.com/rdkcentral.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Module Documentation\n\n# History\n\n|Version|Date (YY-MM-DD) |Comments|\n|-------|----------------|------|\n|1.0| 23/05/09| Initial release |\n\n## Table of Contents\n\n- [Module Documentation](#module-documentation)\n- [History](#history)\n  - [Table of Contents](#table-of-contents)\n- [Overview](#overview)\n- [Structure](#structure)\n- [Reference Template](#reference-template)\n\n# Overview\n\nAs part of the requirement in creating a code module, it must be documented.\n\nThis class creates a common framework for including documentation in a common way.\n\n- Template Location - https://github.com/rdkcentral/hal-doxygen\n\n# Structure\n\nThe structure of repo of the surrounding module is expected to be :-\n\n```\n.\n├── docs\n│   ├── build                   -\u003e [This repo]\n│   │   ├── pages               -\u003e [Common Markdown files to include]\n│   └── template                -\u003e [Reference template][(#reference_template)\n│   ├── generate_docs.sh        -\u003e module specific script to call ./build/Makefile [user defined]\n│   ├── output                  -\u003e Output Directory [Autogenerated]\n│   └── pages                   -\u003e User defined pages *.md search pattern applied from the doxygen configuration\n│       ├── CONTRIBUTING.md -\u003e ../../CONTRIBUTING.md    -\u003e Link to page to include from top level .md extension required\n│       ├── halspec.md                                  -\u003e First Page in the documentation\n│       ├── images                                      -\u003e Contains images to include from the .md files\n│       ├── LICENSE.md -\u003e ../../LICENSE                 -\u003e Link to page to include from top level .md extension required\n│       └── NOTICE.md -\u003e ../../NOTICE                   -\u003e Link to page to include from top level .md extension required\n├── include                                             -\u003e Location of header files *.h search pattern applied from the doxygen configuration\n```\n\n* Note: pages *.md is searched, as well as include/*.h\n\n# Reference Template\n\nIncluding in this repository in the `template` directory reference structure for the document directory.\n\nThis should be copied verbatim, then modifier as required for the specific component where `HAL` documentation is to be generated.\n\n```\ntemplate\n└── docs\n    ├── generate_docs.sh\n    └── pages\n        ├── CONTRIBUTING.md -\u003e ../../CONTRIBUTING.md\n        ├── README.md -\u003e ../../README.md\n        ├── halSpec.md\n        ├── images\n        │   ├── sequence1.png\n        │   ├── sequence_example.mmd\n        │   ├── state1.png\n        │   └── state_example.mmd\n        ├── LICENSE.md -\u003e ../../LICENSE\n        └── NOTICE.md -\u003e ../../NOTICE\n```\n\nThe `generate_docs.sh` when ran will create this `git repo` under the `build` directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdkcentral%2Fhal-doxygen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frdkcentral%2Fhal-doxygen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdkcentral%2Fhal-doxygen/lists"}