{"id":18947189,"url":"https://github.com/qedsoftware/doxygen-demo","last_synced_at":"2025-09-09T01:33:26.904Z","repository":{"id":145932494,"uuid":"9424704","full_name":"qedsoftware/doxygen-demo","owner":"qedsoftware","description":"Demonstration of using Doxygen to generate documentation for C++ code. Credits to Brent Nash.","archived":false,"fork":false,"pushed_at":"2013-05-20T20:37:03.000Z","size":156,"stargazers_count":13,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-09T01:33:19.740Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","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/qedsoftware.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":"2013-04-14T05:07:39.000Z","updated_at":"2025-08-30T14:31:50.000Z","dependencies_parsed_at":"2023-03-23T07:40:53.306Z","dependency_job_id":null,"html_url":"https://github.com/qedsoftware/doxygen-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/qedsoftware/doxygen-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qedsoftware%2Fdoxygen-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qedsoftware%2Fdoxygen-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qedsoftware%2Fdoxygen-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qedsoftware%2Fdoxygen-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qedsoftware","download_url":"https://codeload.github.com/qedsoftware/doxygen-demo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qedsoftware%2Fdoxygen-demo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274232028,"owners_count":25245856,"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-08T02:00:09.813Z","response_time":121,"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":[],"created_at":"2024-11-08T13:09:12.707Z","updated_at":"2025-09-09T01:33:26.880Z","avatar_url":"https://github.com/qedsoftware.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"Description\n=============================================\nDemonstration of using Doxygen to automatically generate documentation for C++ code.\n\nAuthoring credits go to Brent Nash who wrote this code for a Doxygen tutorial delivered at USC (http://merlot.usc.edu/cs102-s12/doxygen/).   \n\nI only added CMake support and a README.\n\nWilliam Wu, 2013-03-25 22:41\n\nBuilding code using CMake:\n=============================================\n\n\t[doxygen-demo]$ mkdir build\n\n\t[doxygen-demo]$ cd build\n\n\t[doxygen-demo/build]$ cmake ..\n\n\t[doxygen-demo/build]$ make\n\nNote that the last two commands are executed inside the build directory.\n\nAfterwards, your tree structure should look like this:\n\n\t[doxygen-demo]$ tree -L 2\n\t.\n\t|-- CMakeLists.txt\n\t|-- README.txt\n\t|-- build\n\t|   |-- CMakeCache.txt\n\t|   |-- CMakeFiles\n\t|   |-- Makefile\n\t|   |-- cmake_install.cmake\n\t|   |-- src\n\t|-- src\n\t    |-- CMakeLists.txt\n\t    |-- main.cpp\n\nand you can execute the program in the build/src directory as follows:\n\n    [doxygen-demo/build/src]$ ./shape_demo\n\nFor more information on using CMake, check out http://www.cmake.org/cmake/help/cmake_tutorial.html\n\n\nConstructing Doxygen documentation:\n=============================================\n\n\t[doxygen-demo]$ cd src\n\n\t[doxygen-demo/src]$ doxygen Doxyfile\n\n\t[doxygen-demo/src]$ cd latex\n\n\t[doxygen-demo/src/latex]$ make\n\nHTML documentation will then reside in doxygen-demo/src/html\nLaTeX documentation will then reside at doxygen-demo/src/latex/refman.pdf\n\nPro tip: to launch an instant localhost HTTP server for viewing the HTML documentation, you can type:\n\n    doxygen-demo/src/html]$ python -m SimpleHTTPServer\n\nthen go to http://localhost:8000/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqedsoftware%2Fdoxygen-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqedsoftware%2Fdoxygen-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqedsoftware%2Fdoxygen-demo/lists"}