{"id":22796431,"url":"https://github.com/macmade/xsdocgen","last_synced_at":"2025-04-19T13:13:04.670Z","repository":{"id":16930082,"uuid":"19691809","full_name":"macmade/XSDocgen","owner":"macmade","description":"An Apple-like documentation generator for C, C++ and Objective-C based on HeaderDoc.","archived":false,"fork":false,"pushed_at":"2021-08-02T22:45:02.000Z","size":99,"stargazers_count":10,"open_issues_count":0,"forks_count":3,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-29T08:11:19.695Z","etag":null,"topics":["apple","documentation","documentation-tool","headerdoc"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/macmade.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}},"created_at":"2014-05-12T08:51:25.000Z","updated_at":"2024-01-05T15:40:36.000Z","dependencies_parsed_at":"2022-09-22T17:31:07.047Z","dependency_job_id":null,"html_url":"https://github.com/macmade/XSDocgen","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/macmade%2FXSDocgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/macmade%2FXSDocgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/macmade%2FXSDocgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/macmade%2FXSDocgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/macmade","download_url":"https://codeload.github.com/macmade/XSDocgen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249701559,"owners_count":21312757,"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":["apple","documentation","documentation-tool","headerdoc"],"created_at":"2024-12-12T05:12:58.567Z","updated_at":"2025-04-19T13:13:04.638Z","avatar_url":"https://github.com/macmade.png","language":"PHP","funding_links":["https://patreon.com/macmade","https://paypal.me/xslabs"],"categories":[],"sub_categories":[],"readme":"XSDocgen\n========\n\n[![Build Status](https://img.shields.io/travis/macmade/XSDocgen.svg?branch=master\u0026style=flat)](https://travis-ci.org/macmade/XSDocgen)\n[![Issues](http://img.shields.io/github/issues/macmade/XSDocgen.svg?style=flat)](https://github.com/macmade/XSDocgen/issues)\n![Status](https://img.shields.io/badge/status-active-brightgreen.svg?style=flat)\n![License](https://img.shields.io/badge/license-mit-brightgreen.svg?style=flat)\n[![Contact](https://img.shields.io/badge/contact-@macmade-blue.svg?style=flat)](https://twitter.com/macmade)  \n[![Donate-Patreon](https://img.shields.io/badge/donate-patreon-yellow.svg?style=flat)](https://patreon.com/macmade)\n[![Donate-Gratipay](https://img.shields.io/badge/donate-gratipay-yellow.svg?style=flat)](https://www.gratipay.com/macmade)\n[![Donate-Paypal](https://img.shields.io/badge/donate-paypal-yellow.svg?style=flat)](https://paypal.me/xslabs)\n\nAbout\n-----\n\nAn Apple-like documentation generator for C, C++ and Objective-C based on HeaderDoc.\n\nXSDocgen uses the [HeaderDoc](https://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) utility to produce documentation from header files in XML format.  \nOnce the XML files have been generated, it will create a standalone PHP website, displaying the documentation.\n\nHighlights\n----------\n\n * Support for custom HTML/PHP pages for additional documentation (companion guides).\n * Printer friendly version.\n * Full search from the documentation and the additional pages.\n * Full XHTML 1.0 strict and CSS compliance.\n * C, C++ and Objective-C support.\n\nExample documentation\n---------------------\n\n### C project:\n\nA real world C example output can be found at: http://doc.xs-labs.com/XSFoundation/\n\n### Objective-C project:\n\nA real world Objective-C example output can be found at: http://doc.xs-labs.com/ClangKit/\n\nBuild \u0026 Installation\n--------------------\n\nFrom the XSDocgen root directory, from a command line prompt, type:\n\n    make\n    sudo make install\n    \nThis will build XSDocgen and install it in `/usr/local/`.  \nThe executable will be located in `/usr/local/bin/`, while the resources will be located in `/usr/local/share/`.\n\nCommand line options\n--------------------\n\n * `--help`  \n   Displays the program's help.\n * `--version`  \n   Displays the program's version.\n * `--verbose`  \n   Displays the output from HeaderDoc.\n * `--enable-c++`  \n   Turns on C++ support for HeaderDoc.\n * `--source [PATH]`  \n   The path of the source files/headers (**mandatory**).\n * `--output [PATH]`  \n   The path of the output directory (**mandatory** - the directory must exist).\n * `--clear`  \n   Clears all previous output files from the XSDocgen output directories.\n * `--undocumented`  \n   Keeps undocumented members.\n * `--old-style`  \n   Uses the old documentation style (before Yosemite).\n * `--project-name [VALUE]`  \n   The name of the project (**mandatory**).\n * `--project-copyright [VALUE]`  \n   The copyright string (**mandatory** - may contain date format specifiers).\n * `--project-version [VALUE]`  \n   The project version string (**mandatory**).\n * `--project-timezone [VALUE]`  \n   An optional timezone specifier (eg: `Europe/Zurich`).\n * `--company-name [VALUE]`  \n   The company name (**mandatory**).\n * `--company-url [VALUE]`   \n   The URL of the company website.\n * `--page-home [PATH]`  \n   The path to an HTML or PHP file (body contents only) to use as start page.\n * `--exclude-file [PATH]`  \n    The path to file with paths to exclude.\n * `--source-root-prefix [PATH]`  \n   A path prefix to strip from the documentation output.\n * `--classes-prefix [PATH]`  \n   An optional path from which the files should be categorised as classes.\n * `--functions-prefix [PATH]`  \n   An optional path from which the files should be categorised as functions.\n * `--types-prefix [PATH]`  \n   An optional path from which the files should be categorised as types.\n * `--page-add [TITLE] [PATH]`  \n   The path to an HTML or PHP file (body contents only) to add to the documentation.  \n   This argument can be specified multiple times.\n * `--html-header-add [VALUE]`  \n   An optional string to add to the header of the HTML output.  \n   You can use it to add custom CSS files, scripts, meta tags, etc.  \n   This argument can be specified multiple times.\n * `--google-analytics [CODE] [DOMAIN]`  \n   An optional tracking code and domain if you want to use Google Analytics.\n * `--google-analytics-display-features`  \n   Enables Display Advertising features on Google Analytics.\n\nInvocation example\n------------------\n\n    XSDocgen --source ./source \\\n             --output ./doc \\\n             --project-name \"My Project\"\n             --project-copyright \"XS-Labs \u0026copy; %Y - All Rights Reserved\"\n             --project-version \"1.0.0-0\"\n             --company-name \"XS-Labs\"\n             --company-url \"http://www.xs-labs.com/\"\n\nLicense\n-------\n\nXSDocgen is released under the terms of the MIT license.\n\nRepository Infos\n----------------\n\n    Owner:\t\t\tJean-David Gadina - XS-Labs\n    Web:\t\t\twww.xs-labs.com\n    Blog:\t\t\twww.noxeos.com\n    Twitter:\t\t@macmade\n    GitHub:\t\t\tgithub.com/macmade\n    LinkedIn:\t\tch.linkedin.com/in/macmade/\n    StackOverflow:\tstackoverflow.com/users/182676/macmade\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmacmade%2Fxsdocgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmacmade%2Fxsdocgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmacmade%2Fxsdocgen/lists"}