{"id":16649482,"url":"https://github.com/rapptz/doxydoc","last_synced_at":"2025-10-02T23:34:56.462Z","repository":{"id":66092937,"uuid":"14327768","full_name":"Rapptz/DoxyDoc","owner":"Rapptz","description":"A sublime text plugin for C++ document autocompletion","archived":false,"fork":false,"pushed_at":"2019-08-16T21:04:48.000Z","size":23,"stargazers_count":27,"open_issues_count":12,"forks_count":13,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-08T23:46:40.819Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/Rapptz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2013-11-12T09:26:37.000Z","updated_at":"2023-09-08T16:43:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"d85c49ce-4d38-425e-8fee-5602af72891a","html_url":"https://github.com/Rapptz/DoxyDoc","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapptz%2FDoxyDoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapptz%2FDoxyDoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapptz%2FDoxyDoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapptz%2FDoxyDoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rapptz","download_url":"https://codeload.github.com/Rapptz/DoxyDoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235048982,"owners_count":18927715,"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":[],"created_at":"2024-10-12T09:10:36.137Z","updated_at":"2025-10-02T23:34:56.113Z","avatar_url":"https://github.com/Rapptz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## DoxyDoc\r\n\r\nDoxyDoc is a plug-in that allows you to auto-complete doc block comments for C++ using Doxygen. Inspired by\r\n[PhpDoc](https://github.com/SublimeText/PhpDoc) and [DocBlockr](https://github.com/spadgos/sublime-jsdocs) this was made due\r\nto frustrations due to lack of proper C++ support from DocBlockr. The latter plug-in had no capabilities to parse templated\r\nfunctions or classes and would just leave the comment hanging.\r\n\r\nThere are no plans to support other languages as DocBlockr does this job fairly well.\r\n\r\n## Installation\r\n\r\nThe easy way to install this is through Package Control.\r\n\r\n- Press Ctrl + Shift + P\r\n- Type \"install\" without quotes to get to Package Control: Install Package\r\n- Type \"DoxyDoc\" without quotes and you'll see this package.\r\n\r\nAnother way to install this is through running `git clone` of this repository in your package directory.\r\n\r\nThe command to do so is the following:\r\n\r\n    git clone https://github.com/Rapptz/doxydoc.git DoxyDoc\r\n\r\n## Usage\r\n\r\nJust like DocBlockr, pressing `/**` and then enter or tab would automatically insert the corresponding documentation.\r\nThere are no keyboard shortcuts to memorise.\r\n\r\n![](http://rapptz.github.io/doxydoc/images/comment-complete.gif)\r\n\r\nAs you can see, pressing enter consecutively would automatically continue the comment.\r\n\r\nDoxyDoc also supports C++ function documenting in various forms.\r\n\r\nA basic function is trivial to document:\r\n\r\n![](http://rapptz.github.io/doxydoc/images/function1.gif)\r\n\r\nIf a function has a template parameter, a `@tparam` property is automatically added as well.\r\n\r\n![](http://rapptz.github.io/doxydoc/images/function2.gif)\r\n\r\nHowever if the function uses the template type parameter in the function it'll try its best to not include it.\r\n\r\n![](http://rapptz.github.io/doxydoc/images/function3.gif)\r\n\r\nDoxyDoc also supports adding the `@return` property if the return value is not void.\r\n\r\n![](http://rapptz.github.io/doxydoc/images/function4.gif)\r\n\r\nDoxyDoc also supports basic documenting of class names, templated or not.\r\n\r\n![](http://rapptz.github.io/doxydoc/images/templateclass.gif)\r\n\r\nNote that all the fields are just Sublime Text snippets, so tabbing over will allow you to seamlessly edit the\r\nparameters for the tags.\r\n\r\nAlong with automatically generating documentation, DoxyDoc allows autocompletion of some common Doxygen snippets as listing\r\n[all of the supported ones](http://www.stack.nl/~dimitri/doxygen/manual/commands.html) would be extremely big. You can get\r\na list of them by pressing `@` and a list will pop up automatically.\r\n\r\nA couple things from DocBlockr are lacking though, which you can find in the TODO below.\r\n\r\n## Issues and Limitations\r\n\r\nC++ is notoriously hard to parse, so it'll be insane to say that this so-called parser is perfect as it is far from it.\r\nOccasional bugs are sure to pop up every so often, which is why I made this to be as simple as possible. Since the \"parser\" is\r\nessentially a bunch of regex under the hood, some abnormalities are bound to pop up because I chose to take part in two\r\nproblems rather than one.\r\n\r\nLimitations are mostly involving template parameters and some complex functions. I also haven't tried function pointers in\r\nfunction arguments, so that will most likely be faulty as well. You are free to open up an issue in the issue\r\ntracker if you believe the bug is too severe or it ruins your flow. You're also welcome to submit a patch yourself to fix the\r\nfunctionality. :)\r\n\r\n## Todo\r\n\r\n- Allow configuration of options. Some examples:\r\n    - Ability to insert @author tags in the snippets\r\n    - Indentation choice\r\n- Support other types of comments such as /// and //!\r\n- Variable documentation\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapptz%2Fdoxydoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frapptz%2Fdoxydoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapptz%2Fdoxydoc/lists"}