{"id":16829835,"url":"https://github.com/rtfb/vim-dox-spell","last_synced_at":"2026-02-16T15:35:17.368Z","repository":{"id":4965347,"uuid":"6122969","full_name":"rtfb/vim-dox-spell","owner":"rtfb","description":null,"archived":false,"fork":false,"pushed_at":"2012-10-08T10:45:41.000Z","size":500,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-07T02:58:41.106Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"VimL","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/rtfb.png","metadata":{"files":{"readme":"README","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":"2012-10-08T10:43:26.000Z","updated_at":"2019-04-21T12:18:07.000Z","dependencies_parsed_at":"2022-08-19T03:31:29.586Z","dependency_job_id":null,"html_url":"https://github.com/rtfb/vim-dox-spell","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rtfb/vim-dox-spell","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtfb%2Fvim-dox-spell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtfb%2Fvim-dox-spell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtfb%2Fvim-dox-spell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtfb%2Fvim-dox-spell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rtfb","download_url":"https://codeload.github.com/rtfb/vim-dox-spell/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtfb%2Fvim-dox-spell/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29511642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T09:05:14.864Z","status":"ssl_error","status_checked_at":"2026-02-16T08:55:59.364Z","response_time":115,"last_error":"SSL_read: 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":"2024-10-13T11:35:56.362Z","updated_at":"2026-02-16T15:35:17.349Z","avatar_url":"https://github.com/rtfb.png","language":"VimL","funding_links":[],"categories":[],"sub_categories":[],"readme":"\nVimDoxSpell\n===========\n         Current Web home: http://rtfb.lt/projects/vim-dox-spell/\n\nVimDoxSpell is a sample program and a collection of sample files to make\nyour Vim editor be nice^H^H^H^H VERY nice about doxygen comments in your\nsource files.\n\nIt contains a patched doxygen.vim script that comes with Vim itself.\nThe patch fixes some problems I had. Having doxygen comment highlighting\nfixed, this package aims to solve another frequent problem in source code\nediting: spell checker's false positives on program identifiers. This is\nsolved by converting the tags file into additional Vim's spelling dictionary.\n\nThis package is intended to be an \"almost working\" sample with exhaustive\ndocumentation. The \"almost\" part comes from the nature of the problem at\nhand: you should base your personal solution on this sample, adopting it\nto your particular needs in your unique development environment.\n\nThis software is in public domain. It is intended to be customized by\nits nature. This program is distributed in the hope that it will be\nuseful, but WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\nI would appreciate being acknowledged in any derived work. Any comments,\nsuggestions, corrections or patches are welcome. Even hate-mail will be\nwell met, not to mention fan-mail :-)\n\nPlease report bugs in VimDoxSpell to Vytautas.Shaltenis@gmail.com.\n\nVimDoxSpell's home page is at\n\u003chttp://rtfb.lt/projects/vim-dox-spell/\u003e.\n\nMAINTAINER: Vytautas Saltenis \u003cVytautas.Shaltenis@gmail.com\u003e\n\nCopyright (C) 2008, Vytautas Saltenis\n\nUsing VimDoxSpell\n=================\n\nThis package is intended to be a sample and a guide. Start by examining\nvimrc-sample and setting up your Vim editor. As a part of configuration,\ncopy doxygen.vim to Vim's syntax directory, i.e. do this:\n\n$ mkdir -p ~/.vim/syntax\n$ cp doxygen.vim ~/.vim/syntax\n\nMy changes for this file have not yet been reviewed by the maintainer of the\nsyntax script.\n\nNext, figure out how do you want to generate tags for your code base.\nIdeally, this should be done somewhere in your scripts that pull from\nrepositories, so that the tags file is always up to date.\n\nNow figure out where doxygen puts its XML files. These can be used to\nextend your dictionary with the names of groups of your functions. If your\ndocumentation does not rely on explicit grouping, you can edit the script\nto skip this part.\n\nCall tagstospl.py script with paths to your tags and index.html files. If you\nwish, incorporate a call to this script into your build process, right after\nthe call to doxygen.\n\nYou're done! You can now launch your beloved editor and happily check the\nspelling of your documentation. No more false positives!\n\nNote: If your documentation contains a lot of references to some fixed\nAPI (e.g. you're writing a game and you mention OpenGL functions a lot),\nit might prove useful to hack in an additional step of merging two tags\nfiles: one for your code base, and one for the headers of the API.\n\nWarning: All this is nice, but be careful, though. If your code is likely\nto contain things that are likely typos of the usual words, you might shoot\nyourself in a foot. A good example if a famous variable name \"wnd\". It is\nlikely to be a typo for \"end\" in your documentation. It won't be detected,\nbecause the spell checker will think you're referring to the variable.\n\nFiles\n=====\n\nvimrc-sample: a sample vimrc file with relevant settings and explanations\n\ndoxygen.vim: a patched Vim syntax script. It should be copied to the syntax\n             folder of the editor. Don't forget to backup the original!\n\ntags-sample: tags generated from you code base. I use Exuberant Ctags\n(http://ctags.sourceforge.net).\n\nindex-sample.xml: a sample of index.xml that is generated by doxygen.\n\ntagstospl.py: the smart part of this package. A script to generate the\n              dictionary to be used to eliminate false positives.\n\nc-files/: directory with test/sample C files. The \"code base\".\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frtfb%2Fvim-dox-spell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frtfb%2Fvim-dox-spell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frtfb%2Fvim-dox-spell/lists"}