[ { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: bug\nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**Code example**\n\n```Cpp\n// Put your code here\n```\n\n**Expected result**\n\n```Cpp\n/**\n * @brief Put the expected comment here\n */\n```\n\n**Actual result**\n\n```Cpp\n/**\n * @brief Put the actually generated comment here\n */\n```\n\n**Screencaps**\nIf applicable, add screencaps to help explain your problem.\n\n**Your System:**\n - OS: [Windows, macOS, Linux]\n - VS Code Version [e.g. 1.55]\n - Doxdocgen Code Version [e.g. 1.3.1]\n\n**Additional context**\nAdd any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: enhancement\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".github/ISSUE_TEMPLATE.md", "content": "# Description\n\nAnything you'd like to add\n\n## Code example\n\n```Cpp\n// Put your code here\n```\n\n### Expected result\n\n```Cpp\n/**\n * @brief Put the expected comment here\n */\n```\n\n### Actual result\n\n```Cpp\n/**\n * @brief Put the actually generated comment here\n */\n```\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "# Fix/Feature/Other\n\n## Fix\n\n- [ ] Link to issue. If there is no issue please describe it using at least the issue template\n\n- [ ] Description of the fix\n\n- [ ] Added unit test\n\n## Feature\n\n- [ ] Description of what's added\n\n- [ ] Gif of your feature if appropriate\n\n- [ ] Added gif to README\n\n- [ ] Added unit test\n\n## Other\n\n- [ ] Description\n" }, { "path": ".github/workflows/cd.yml", "content": "name: Release\n\non:\n push:\n branches:\n - master\n pull_request:\n branches:\n - master\n release:\n types:\n - created\n\njobs:\n pipeline:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v2\n\n - name: Use Node.js\n uses: actions/setup-node@v1\n with:\n node-version: '15.11.0'\n - run: yarn\n\n - name: Install VSCE\n run: yarn add vsce ovsx -D\n\n - name: Update $PATH\n run: echo \"$PWD/node_modules/.bin/\" >> $GITHUB_PATH\n\n - name: Build vsix\n run: vsce package && ls -alh\n\n - name: Publish to VS Code Marketplace\n run: vsce publish -p ${VSCE_TOKEN}\n env:\n VSCE_TOKEN: ${{ secrets.VSCE_TOKEN }}\n if: contains(github.ref, 'refs/tags/')\n\n - name: Publish to Open VSX Registry\n run: ovsx publish\n env:\n OVSX_PAT: ${{ secrets.OPEN_VSX_TOKEN }}\n if: contains(github.ref, 'refs/tags/')\n\n - name: Upload vsix to GitHub release\n uses: svenstaro/upload-release-action@v2\n with:\n repo_token: ${{ secrets.GITHUB_TOKEN }}\n file: doxdocgen-*.vsix\n tag: ${{ github.ref }}\n overwrite: true\n file_glob: true\n if: contains(github.ref, 'refs/tags/')\n\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\non:\n push:\n branches: [ master ]\n pull_request:\n branches: [ master ]\n\njobs:\n lint:\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout\n uses: actions/checkout@v2\n\n - name: Use Node.js\n uses: actions/setup-node@v1\n with:\n node-version: '15.11.0'\n - run: yarn\n\n - name: Lint\n run: yarn lint\n \n build:\n needs: lint\n runs-on: ${{ matrix.os }}\n strategy:\n matrix:\n os: [ubuntu-latest, macos-latest, windows-latest]\n steps:\n - name: Checkout\n uses: actions/checkout@v2\n \n - name: Use Node.js\n uses: actions/setup-node@v1\n with:\n node-version: '15.11.0'\n - run: yarn\n\n - name: Compile\n run: yarn compile\n \n test:\n needs: build\n runs-on: ${{ matrix.os }}\n strategy:\n matrix:\n # disable ubuntu-latest until https://github.com/microsoft/vscode/issues/106569 is fixed\n os: [macos-latest, windows-latest]\n steps:\n - name: Checkout\n uses: actions/checkout@v2\n \n - name: Use Node.js\n uses: actions/setup-node@v1\n with:\n node-version: '15.11.0'\n - run: yarn\n\n - name: Test\n run: yarn test\n # Run tests only on non-coverage job\n if: matrix.os != 'macOS-latest'\n \n - name: Generate Coverage\n run: yarn cov\n if: matrix.os == 'macOS-latest'\n\n - name: Publish coverage\n uses: codecov/codecov-action@v1\n with:\n token: ${{ secrets.CODECOV_TOKEN }}\n if: matrix.os == 'macOS-latest'\n \n - name: Upload coverage\n uses: actions/upload-artifact@v2\n with:\n name: cov\n path: coverage\n if: matrix.os == 'macOS-latest'\n\n" }, { "path": ".github/workflows/codeql-analysis.yml", "content": "# For most projects, this workflow file will not need changing; you simply need\n# to commit it to your repository.\n#\n# You may wish to alter this file to override the set of languages analyzed,\n# or to provide custom queries or build logic.\n#\n# ******** NOTE ********\n# We have attempted to detect the languages in your repository. Please check\n# the `language` matrix defined below to confirm you have the correct set of\n# supported CodeQL languages.\n#\nname: \"CodeQL\"\n\non:\n push:\n branches: [ master ]\n pull_request:\n # The branches below must be a subset of the branches above\n branches: [ master ]\n schedule:\n - cron: '32 8 * * 3'\n\njobs:\n analyze:\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n security-events: write\n\n strategy:\n fail-fast: false\n matrix:\n language: [ 'javascript' ]\n # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]\n # Learn more:\n # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v2\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v1\n with:\n languages: ${{ matrix.language }}\n # If you wish to specify custom queries, you can do so here or in a config file.\n # By default, queries listed here will override any specified in a config file.\n # Prefix the list here with \"+\" to use these queries and those in the config file.\n # queries: ./path/to/local/query, your-org/your-repo/queries@main\n\n # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).\n # If this step fails, then you should remove it and run the build manually (see below)\n - name: Autobuild\n uses: github/codeql-action/autobuild@v1\n\n # ℹī¸ Command-line programs to run using the OS shell.\n # 📚 https://git.io/JvXDl\n\n # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines\n # and modify them (or add more) to build your code if your project\n # uses a compiled language\n\n #- run: |\n # make bootstrap\n # make release\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v1\n" }, { "path": ".gitignore", "content": "out\nnode_modules\n.vscode-test/\n*.vsix\ncoverage/\n.DS_Store\n/npm-debug.log\n/.nyc_output/\npackage-lock.json" }, { "path": ".nycrc", "content": "{\n \"extends\": \"@istanbuljs/nyc-config-typescript\",\n \"cache\": false,\n \"cwd\": \"./\",\n \"exclude\": [\n \"**/**.test.js\"\n ],\n \"extension\": [\n \".ts\",\n \".tsx\"\n ],\n \"hookRequire\": true,\n \"hookRunInContext\": true,\n \"hookRunInThisContext\": true,\n \"instrument\": true,\n \"reporter\": [\"json\", \"text\"],\n \"recursive\": true,\n \"require\": [\n \"ts-node/register\",\n \"source-map-support/register\"\n ],\n \"sourceMap\": true,\n \"all\": true,\n \"include\": [ \"src/Lang\" ]\n}\n" }, { "path": ".vscode/launch.json", "content": "// A launch configuration that compiles the extension and then opens it inside a new window\n{\n \"version\": \"0.1.0\",\n \"configurations\": [\n {\n \"name\": \"Launch Extension\",\n \"type\": \"extensionHost\",\n \"request\": \"launch\",\n \"runtimeExecutable\": \"${execPath}\",\n \"args\": [\"--extensionDevelopmentPath=${workspaceRoot}\" ],\n \"stopOnEntry\": false,\n \"sourceMaps\": true,\n \"outFiles\": [ \"${workspaceRoot}/out/**/*.js\" ],\n \"preLaunchTask\": \"npm: compile\"\n },\n {\n \"name\": \"Launch Tests\",\n \"type\": \"extensionHost\",\n \"request\": \"launch\",\n \"runtimeExecutable\": \"${execPath}\",\n \"args\": [\"--extensionDevelopmentPath=${workspaceRoot}\", \"--extensionTestsPath=${workspaceRoot}/out/test\", \"--disable-extensions\" ],\n \"stopOnEntry\": false,\n \"sourceMaps\": true,\n \"outFiles\": [ \"${workspaceRoot}/out/test/**/*.js\" ],\n \"preLaunchTask\": \"npm: compile\"\n }\n ]\n}\n" }, { "path": ".vscode/settings.json", "content": "// Place your settings in this file to overwrite default and user settings.\n{\n \"files.exclude\": {\n \"out\": false // set this to true to hide the \"out\" folder with the compiled JS files\n },\n \"search.exclude\": {\n \"out\": true // set this to false to include \"out\" folder in search results\n }\n}" }, { "path": ".vscode/tasks.json", "content": "// See https://go.microsoft.com/fwlink/?LinkId=733558\n// for the documentation about the tasks.json format\n{\n \"version\": \"2.0.0\",\n \"tasks\": [\n {\n \"type\": \"npm\",\n \"script\": \"watch\",\n \"problemMatcher\": \"$tsc-watch\",\n \"isBackground\": true,\n \"presentation\": {\n \"reveal\": \"never\"\n },\n \"group\": {\n \"kind\": \"build\",\n \"isDefault\": true\n }\n }\n ]\n}" }, { "path": ".vscodeignore", "content": ".vscode/**\n.vscode-test/**\nout/test/**\nout/**/*.map\nsrc/**\n.gitignore\ntsconfig.json\nvsc-extension-quickstart.md\n.travis.yml\nappveyor.yml\ncoverconfig.json\npublish_coverage.sh\n.github/**" }, { "path": "CHANGELOG.md", "content": "# Change Log\n\n## [1.4.0]\n\n### Feature\n\n- Use `vscode.workspace.workspaceFolders[0]` to construct SimpleGit instance (#268)\n Thanks to @lukester1975\n\n### Fix\n\n- Add official VS Code Language identifier for CUDA (#273)\n Thanks to @jobtijhuis\n\n## [1.3.2]\n\n### Fix\n\n- Indent alignment not working in file comments (#206) (#236)\n Thanks to @HO-COOH\n\n- Several typos (#233)\n Thanks to @jogo-\n\n## [1.3.1]\n\n### Fix\n\n- Only suggest Doxygen snippet's when the cursor is in a comment section (#224) (#229)\n Thanks to @HO-COOH\n\n## [1.3.0]\n\n### Feature\n\n- Add `{file}` template, so it can be used in custom tag of both file comments and generic comments (#191) (#221)\n Thanks to @HO-COOH\n\n## [1.2.2]\n\n### Fix\n\n- Fix tags in generic order not expanded (#204) (#217)\n Thanks to @HO-COOH\n\n## [1.2.1]\n\n### Fix\n\n- Fix unexpected return tag on non-functions (#210) (#214)\n Thanks to @HO-COOH\n\n## [1.2.0]\n\n### Feature\n\n- Doxygen command Intellisense support (#211)\n Thanks to @HO-COOH\n\n### Other\n\n- Nicer setting descriptions (#209)\n Thanks to @HO-COOH\n\n## [1.1.0]\n\n### Feature\n\n- Substitute author and email by git config (#186) (#182)\n Thanks to @to-s\n\n### Other\n\n- Update to Typescript 3.8.3\n\n## [1.0.1]\n\n### Fix\n\n- Files without includes don't trigger the autocomplete for file description (#141) (#183)\n Thanks to @to-s\n\n## [1.0.0]\n\n### Revert\n\n- Revert reverting Replace environment variables in templated strings. If no environment variable can be found the name of the variable will be inserted (#110)\n\n### Other\n\n- vsce packaging is forcing yarn even if no yarn config exists. Override this behavior now to use npm.\n\n## [0.8.2]\n\n### Other\n\n- Package with older version of vsce\n\n## [0.8.1]\n\n### Revert\n\n- Replace environment variables in templated strings. If no environment variable can be found the name of the variable will be inserted (#110)\n\n## [0.8.0]\n\n### Feature\n\n- Support for arbitrary tags (#169)\n\n- Replace environment variables in templated strings. If no environment variable can be found the name of the variable will be inserted (#110)\n\n### Fix\n\n- Incorrect parameter name of template (#170)\n\n## [0.7.2]\n\n### Fix\n\n- Could not generate correct file header annotation (again) #164 (#161)\n\n## [0.7.1]\n\n### Fix\n\n- Could not generate correct file header annotation #162 (#161)\n\n## [0.7.0]\n\n### Feature\n\n- Add option to filter keywords (like custom defines) from input line #159 (#152)\n\n### Fix\n\n- Argument type would be placed as the param instead of the argument name #154\n\n Thanks to @DaanHuinink\n\n- Bug when commenting macros #158 (#142)\n\n## [0.6.0]\n\n### Feature\n\n- Add support for multiline template #140 (#127)\n \n Thanks to @eternalphane\n\n- Enable CUDA language support #148 (#128)\n \n Thanks to @trxcllnt\n\n### Other\n\n- Update dev dependencies\n\n## [0.5.2]\n\n### Fix\n\n- Cannot see params & return value, for global functions (#136)\n\n## [0.5.1]\n\n### Fix\n\n- Ignore `restrict` keyword in C function parameter pointer (#121)\n\n- Parameters not generated when using custom trigger (#119)\n\n- Function argument. Pointer to table is not generated. (#123)\n\n### Other\n\n- Update dev dependencies and increase min VS Code version (#131, #132)\n\n## [0.5.0]\n\n### Feature\n\n- Feature suggest: Indent option (#107)\n\n#### Alignment\n\nThis version introduces the possibility to align text elements in config strings at a specified width.\n\nExample:\n\n```json\n\"doxdocgen.generic.paramTemplate\": \"@param{indent:10}{param}{indent:30}My Param doc\"\n```\n\nwill turn into\n\n```cpp\n/**\n * @param foo My Param doc\n * @param barIsAlsoAnOption My Param doc\n */\nvoid bar(int foo, int barIsAlsoAnOption);\n```\n\nYou can use the `{indent:}` in any templated config option available. Numbers have to be bigger than 0 to have any effect.\n\nAlignment will be done from the start of the config string, like this:\n\n```json\n\"doxdocgen.generic.paramTemplate\": \"@param {param}{indent:14}test\"\n```\n\n```cpp\n/**\n * @param test\n */ \n |<---------->| // 14\n```\n\n## [0.4.3]\n\n### Fix\n\n- Trigger Sequence /** causes extra */ to be generated and the comment block isn't fully generated. (#111)\n\n## [0.4.2]\n\n### Fix\n\n- Invalid argument name for C `enum` types (#102)\n\n## [0.4.1]\n\n### Fix\n\n- Wrong \\param value generation. (#91)\n\n## [0.4.0]\n\n### Feature\n\n- Additional file header fields for version, copyright, and custom text (#89)\n\n## [0.3.3]\n\n### Fix\n\n- Doesn't parse CPP member pointer names correctly (#78)\n\n## [0.3.2]\n\n### Fix\n\n- Cannot read property 'text' of undefined (#79)\n\n## [0.3.1]\n\n### Fix\n\n- Don't create a comment while editing an existing comment. (#67)\n\n## [0.3.0]\n\n### Features\n\n- Custom Doxygen tag order for methods (#55)\n\n- Suggest smart text (#57)\n\n For more details see [README.md](https://github.com/christophschlosser/doxdocgen/tree/0.3.0#smart-text)\n\n- Config keys are now grouped, see [Config update](#config-update) for changes\n\n### Config update\n\n| Old value | New value | Change |\n|---------------------------------------|----------------------------------------|:--------:|\n| doxdocgen.generic.triggerSequence | doxdocgen.c.triggerSequence | Category |\n| doxdocgen.generic.firstLine | doxdocgen.c.firstLine | Category |\n| doxdocgen.generic.commentPrefix | doxdocgen.c.commentPrefix | Category |\n| doxdocgen.generic.lastLine | doxdocgen.c.lastLine | Category |\n| | doxdocgen.c.setterText | Added |\n| | doxdocgen.c.getterText | Added |\n| | doxdocgen.c.factoryMethodText | Added |\n| doxdocgen.generic.newLineAfterTParams | | Removed |\n| doxdocgen.generic.newLineAfterBrief | | Removed |\n| doxdocgen.generic.newLineAfterParams | | Removed |\n| doxdocgen.generic.tparamTemplate | doxdocgen.cpp.tparamTemplate | Category |\n| | doxdocgen.cpp.ctorText | Added |\n| | doxdocgen.cpp.dtorText | Added |\n| doxdocgen.generic.fileTemplate | doxdocgen.file.fileTemplate | Category |\n| doxdocgen.generic.fileOrder | doxdocgen.file.fileOrder | Category |\n| | doxdocgen.generic.generateSmartText | Added |\n| | doxdocgen.generic.splitCasingSmartText | Added |\n| | doxdocgen.generic.order | Added |\n\n## [0.2.1]\n\n- Hotfix. Include moment.js as runtime dependency\n\n## [0.2.0]\n\n- Fix #51\n\n- Fix #52\n\n## [0.1.0]\n\n- Fix #40\n\n- Fix #38\n\n- Fix #37\n\n- Fix #36\n\n- Fix #28\n\n- Fix #24\n\n- Implemented support for `noexcept` and `throw`\n\n- Implemented support for `constexpr` and `final`\n\n- Implemented support for unnamed parameters, this broke in version 0.0.7\n\n- Add new config variable that allows a user to disable the true and false return on bool types and make it behave like a normal type\n\n## [0.0.7]\n\n- Fix #31\n\n- Fixed bug where using a different trigger sequence than \"*\" causes a newline to be added between the comment and the documented entity.\n\n## [0.0.6]\n\n- Improve and fix comment generation for several C++ features (#23) (thanks to @rowanG077 again)\n\n## [0.0.5]\n\n- Extend customization of generated documentation (#15, #16) (thanks to @rowanG077)\n\n- Fix #10\n\n## [0.0.4]\n\n- Fix #9\n\n- Add option to choose if the return type should be included in generated documentation\n\n## [0.0.3]\n\n- Add possibility to set comment start indicator to Qt style\n\n## [0.0.2]\n\n- Add C parser and generator\n\n## [0.0.1]\n\n- Initial release\n" }, { "path": "LICENSE", "content": "The MIT License (MIT)\n\nCopyright (c) 2017-2021 Christoph Schlosser\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n" }, { "path": "README.md", "content": "# Generate Doxygen Comments in VS Code\n\nThis VS Code Extensions provides Doxygen Documentation generation on the fly by starting a Doxygen comment block and pressing enter.\n\n[![CI build status](https://img.shields.io/github/workflow/status/cschlosser/doxdocgen/CI/master)](https://github.com/cschlosser/doxdocgen/actions/workflows/ci.yml?query=branch%3Amaster)\n[![Release build status](https://img.shields.io/github/workflow/status/cschlosser/doxdocgen/CD?label=Release)](https://github.com/cschlosser/doxdocgen/actions/workflows/cd.yml?query=event%3Arelease++)\n[![codecov](https://codecov.io/gh/cschlosser/doxdocgen/branch/master/graph/badge.svg)](https://codecov.io/gh/cschlosser/doxdocgen)\n[![IRC chat](https://img.shields.io/badge/irc.oftc.net-%23doxdocgen-brightgreen)](https://webchat.oftc.net/?channels=doxdocgen)\n\n## Table of Contents\n\n- [Generate Doxygen Comments in VS Code](#generate-doxygen-comments-in-vs-code)\n - [Table of Contents](#table-of-contents)\n - [Features](#features)\n - [Alignment](#alignment)\n - [Attributes](#attributes)\n - [Con- and Destructors](#con--and-destructors)\n - [Extensive customization](#extensive-customization)\n - [File descriptions](#file-descriptions)\n - [Function pointers](#function-pointers)\n - [Operators](#operators)\n - [Parameters](#parameters)\n - [Return types](#return-types)\n - [Smart text](#smart-text)\n - [Trailing](#trailing)\n - [Templates](#templates)\n - [Auto-complete doxygen commands](#auto-complete-doxygen-commands)\n - [Config options](#config-options)\n - [Contributors](#contributors)\n - [Known Issues](#known-issues)\n - [What's to come](#whats-to-come)\n\n## Features\n\n### Alignment\n\n![Alignment](images/alignment.gif)\n\nFor how this works, see the [CHANGELOG.md](https://github.com/cschlosser/doxdocgen/blob/master/CHANGELOG.md#alignment)\n\n### Attributes\n\n![Attribute](images/attributes.gif)\n\n### Con- and Destructors\n\n![Constructor](images/ctor.gif)\n![Destructor](images/dtor.gif)\n\n### Extensive customization\n\n![options](images/options.gif)\n![xml options](images/opts-xml.gif)\n![order of commands](images/opt-order.gif)\n\n### File descriptions\n\n![file description](images/file.gif)\n\n### Function pointers\n\n![func_ptr](images/function_ptr.gif)\n\n### Operators\n\n![Operator](images/operator.gif)\n![Delete Operator](images/op-delete.gif)\n\n### Parameters\n\n![Simple Parameter](images/param_simple.gif)\n![Long Parameter](images/long-param.gif)\n\n### Return types\n\n![Bool return val](images/bool.gif)\n![Declaration](images/declaration.gif)\n\n### Smart text\n\n![Smart text CTor](images/smartTextCtor.gif)\n![Smart text Custom](images/smartTextCustom.gif)\n![Smart text Getter](images/smartTextGet.gif)\n\nSupported smart text snippets:\n\n* Constructors\n\n* Destructors\n\n* Getters\n\n* Setters\n\n* Factory methods\n\nEach of them can be configured with its own custom text and you can decide if the addon should attempt to split the name of the method according to its case.\n\n#### Trailing\n\n![Trailing return](images/trailing.gif)\n\n### Templates\n\n![Template method](images/template.gif)\n![Template class](images/template-class.gif)\n\n### Auto-complete doxygen commands\n\n![Auto complete doxygen](images/doxygen-auto-complete.gif)\n\n\n## Config options\n\n```jsonc\n{\n // The prefix that is used for each comment line except for first and last.\n \"doxdocgen.c.commentPrefix\": \" * \",\n\n // Smart text snippet for factory methods/functions.\n \"doxdocgen.c.factoryMethodText\": \"Create a {name} object\",\n\n // The first line of the comment that gets generated. If empty it won't get generated at all.\n \"doxdocgen.c.firstLine\": \"/**\",\n\n // Smart text snippet for getters.\n \"doxdocgen.c.getterText\": \"Get the {name} object\",\n\n // The last line of the comment that gets generated. If empty it won't get generated at all.\n \"doxdocgen.c.lastLine\": \" */\",\n\n // Smart text snippet for setters.\n \"doxdocgen.c.setterText\": \"Set the {name} object\",\n\n // Doxygen comment trigger. This character sequence triggers generation of Doxygen comments.\n \"doxdocgen.c.triggerSequence\": \"/**\",\n\n // Smart text snippet for constructors.\n \"doxdocgen.cpp.ctorText\": \"Construct a new {name} object\",\n\n // Smart text snippet for destructors.\n \"doxdocgen.cpp.dtorText\": \"Destroy the {name} object\",\n\n // The template of the template parameter Doxygen line(s) that are generated. If empty it won't get generated at all.\n \"doxdocgen.cpp.tparamTemplate\": \"@tparam {param} \",\n\n // File copyright documentation tag. Array of strings will be converted to one line per element. Can template {year}.\n \"doxdocgen.file.copyrightTag\": [\n \"@copyright Copyright (c) {year}\"\n ],\n\n // Additional file documentation. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.\n \"doxdocgen.file.customTag\": [],\n\n // The order to use for the file comment. Values can be used multiple times. Valid values are shown in default setting.\n \"doxdocgen.file.fileOrder\": [\n \"file\",\n \"author\",\n \"brief\",\n \"version\",\n \"date\",\n \"empty\",\n \"copyright\",\n \"empty\",\n \"custom\"\n ],\n\n // The template for the file parameter in Doxygen.\n \"doxdocgen.file.fileTemplate\": \"@file {name}\",\n\n // Version number for the file.\n \"doxdocgen.file.versionTag\": \"@version 0.1\",\n\n // Set the e-mail address of the author. Replaces {email}.\n \"doxdocgen.generic.authorEmail\": \"you@domain.com\",\n\n // Set the name of the author. Replaces {author}.\n \"doxdocgen.generic.authorName\": \"your name\",\n\n // Set the style of the author tag and your name. Can template {author} and {email}.\n \"doxdocgen.generic.authorTag\": \"@author {author} ({email})\",\n\n // If this is enabled a bool return value will be split into true and false return param.\n \"doxdocgen.generic.boolReturnsTrueFalse\": true,\n\n // The template of the brief Doxygen line that is generated. If empty it won't get generated at all.\n \"doxdocgen.generic.briefTemplate\": \"@brief {text}\",\n\n // The format to use for the date.\n \"doxdocgen.generic.dateFormat\": \"YYYY-MM-DD\",\n\n // The template for the date parameter in Doxygen.\n \"doxdocgen.generic.dateTemplate\": \"@date {date}\",\n\n // Decide if you want to get smart text for certain commands.\n \"doxdocgen.generic.generateSmartText\": true,\n\n // Whether include type information at return.\n \"doxdocgen.generic.includeTypeAtReturn\": true,\n\n // How many lines the plugin should look for to find the end of the declaration. Please be aware that setting this value too low could improve the speed of comment generation by a very slim margin but the plugin also may not correctly detect all declarations or definitions anymore.\n \"doxdocgen.generic.linesToGet\": 20,\n\n // The order to use for the comment generation. Values can be used multiple times. Valid values are shown in default setting.\n \"doxdocgen.generic.order\": [\n \"brief\",\n \"empty\",\n \"tparam\",\n \"param\",\n \"return\",\n \"custom\",\n \"version\",\n \"author\",\n \"date\",\n \"copyright\"\n ],\n\n // Custom tags to be added to the generic order. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.\n \"doxdocgen.generic.customTags\": [],\n\n // The template of the param Doxygen line(s) that are generated. If empty it won't get generated at all.\n \"doxdocgen.generic.paramTemplate\": \"@param {param} \",\n\n // The template of the return Doxygen line that is generated. If empty it won't get generated at all.\n \"doxdocgen.generic.returnTemplate\": \"@return {type} \",\n\n // Decide if the values put into {name} should be split according to their casing.\n \"doxdocgen.generic.splitCasingSmartText\": true,\n\n // Array of keywords that should be removed from the input prior to parsing.\n \"doxdocgen.generic.filteredKeywords\": [],\n\n // Substitute {author} with git config --get user.name.\n \"doxdocgen.generic.useGitUserName\": false,\n\n // Substitute {email} with git config --get user.email.\n \"doxdocgen.generic.useGitUserEmail\": false,\n\n // Provide intellisense and snippet for doxygen commands\n \"doxdocgen.generic.commandSuggestion\": true,\n\n // Add `\\\\` in doxygen command suggestion for better readability (need to enable commandSuggestion)\n \"doxdocgen.generic.commandSuggestionAddPrefix\": false,\n}\n```\n\n## Contributors\n\n[Christoph Schlosser](https://github.com/cschlosser)\n\n[Rowan Goemans](https://github.com/rowanG077)\n\n## Known Issues\n\n[See open bugs](https://github.com/cschlosser/doxdocgen/labels/bug)\n\n## What's to come\n\n[See open features](https://github.com/cschlosser/doxdocgen/labels/enhancement)\n" }, { "path": "package.json", "content": "{\n \"name\": \"doxdocgen\",\n \"displayName\": \"Doxygen Documentation Generator\",\n \"description\": \"Let me generate Doxygen documentation from your source code for you.\",\n \"version\": \"1.4.0\",\n \"publisher\": \"cschlosser\",\n \"engines\": {\n \"vscode\": \"^1.55.0\"\n },\n \"categories\": [\n \"Other\"\n ],\n \"badges\": [\n {\n \"url\": \"https://img.shields.io/github/workflow/status/cschlosser/doxdocgen/CI/master\",\n \"href\": \"https://github.com/cschlosser/doxdocgen/actions/workflows/ci.yml?query=branch%3Amaster+\",\n \"description\": \"Continous integration\"\n },\n {\n \"url\": \"https://img.shields.io/github/workflow/status/cschlosser/doxdocgen/CD?label=Release\",\n \"href\": \"https://github.com/cschlosser/doxdocgen/actions/workflows/cd.yml?query=event%3Arelease++\",\n \"description\": \"Release pipeline\"\n },\n {\n \"url\": \"https://codecov.io/gh/cschlosser/doxdocgen/branch/master/graph/badge.svg\",\n \"href\": \"https://codecov.io/gh/cschlosser/doxdocgen\",\n \"description\": \"Code coverage\"\n }\n ],\n \"activationEvents\": [\n \"onLanguage:cuda\",\n \"onLanguage:cuda-cpp\",\n \"onLanguage:cpp\",\n \"onLanguage:c\"\n ],\n \"contributes\": {\n \"configuration\": {\n \"type\": \"object\",\n \"title\": \"Doxygen Documentation Generator Settings\",\n \"properties\": {\n \"doxdocgen.c.triggerSequence\": {\n \"description\": \"Doxygen comment trigger. This character sequence triggers generation of Doxygen comments.\",\n \"type\": \"string\",\n \"default\": \"/**\"\n },\n \"doxdocgen.c.firstLine\": {\n \"description\": \"The first line of the comment that gets generated. If empty it won't get generated at all.\",\n \"type\": \"string\",\n \"default\": \"/**\"\n },\n \"doxdocgen.c.commentPrefix\": {\n \"description\": \"The prefix that is used for each comment line except for first and last.\",\n \"type\": \"string\",\n \"default\": \" * \"\n },\n \"doxdocgen.c.lastLine\": {\n \"description\": \"The last line of the comment that gets generated. If empty it won't get generated at all.\",\n \"type\": \"string\",\n \"default\": \" */\"\n },\n \"doxdocgen.c.setterText\": {\n \"description\": \"Smart text snippet for setters.\",\n \"type\": \"string\",\n \"default\": \"Set the {name} object\"\n },\n \"doxdocgen.c.getterText\": {\n \"description\": \"Smart text snippet for getters.\",\n \"type\": \"string\",\n \"default\": \"Get the {name} object\"\n },\n \"doxdocgen.c.factoryMethodText\": {\n \"description\": \"Smart text snippet for factory methods/functions.\",\n \"type\": \"string\",\n \"default\": \"Create a {name} object\"\n },\n \"doxdocgen.cpp.tparamTemplate\": {\n \"description\": \"The template of the template parameter Doxygen line(s) that are generated. If empty it won't get generated at all.\",\n \"type\": \"string\",\n \"default\": \"@tparam {param} \"\n },\n \"doxdocgen.cpp.ctorText\": {\n \"description\": \"Smart text snippet for constructors.\",\n \"type\": \"string\",\n \"default\": \"Construct a new {name} object\"\n },\n \"doxdocgen.cpp.dtorText\": {\n \"description\": \"Smart text snippet for destructors.\",\n \"type\": \"string\",\n \"default\": \"Destroy the {name} object\"\n },\n \"doxdocgen.file.fileTemplate\": {\n \"description\": \"The template for the file parameter in Doxygen.\",\n \"type\": \"string\",\n \"default\": \"@file {name}\"\n },\n \"doxdocgen.file.copyrightTag\": {\n \"markdownDescription\": \"File copyright documentation tag. Array of strings will be converted to one line per element. Can template `{year}`.\",\n \"type\": [\n \"array\",\n \"string\"\n ],\n \"default\": [\n \"@copyright Copyright (c) {year}\"\n ]\n },\n \"doxdocgen.file.versionTag\": {\n \"description\": \"Version number for the file.\",\n \"type\": \"string\",\n \"default\": \"@version 0.1\"\n },\n \"doxdocgen.file.customTag\": {\n \"markdownDescription\": \"Additional file documentation. Array of strings will be converted to one line per element. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.\",\n \"type\": [\n \"array\",\n \"string\"\n ],\n \"default\": []\n },\n \"doxdocgen.file.fileOrder\": {\n \"markdownDescription\": \"The order to use for the file comment. Values can be used multiple times. Valid values are `file`, `author`, `brief`, `version`, `date`, `empty`, `copyright` and `custom`.\",\n \"type\": [\n \"array\",\n \"string\"\n ],\n \"default\": [\n \"file\",\n \"author\",\n \"brief\",\n \"version\",\n \"date\",\n \"empty\",\n \"copyright\",\n \"empty\",\n \"custom\"\n ]\n },\n \"doxdocgen.generic.includeTypeAtReturn\": {\n \"description\": \"Whether include type information at return.\",\n \"type\": \"boolean\",\n \"default\": true\n },\n \"doxdocgen.generic.boolReturnsTrueFalse\": {\n \"markdownDescription\": \"If this is enabled, the documentation for a `bool` return value will be split into `true` and `false` entries.\",\n \"type\": \"boolean\",\n \"default\": true\n },\n \"doxdocgen.generic.briefTemplate\": {\n \"description\": \"The template of the brief Doxygen line that is generated. If empty it won't get generated at all.\",\n \"type\": \"string\",\n \"default\": \"@brief {text}\"\n },\n \"doxdocgen.generic.paramTemplate\": {\n \"description\": \"The template of the param Doxygen line(s) that are generated. If empty it won't get generated at all.\",\n \"type\": \"string\",\n \"default\": \"@param {param} \"\n },\n \"doxdocgen.generic.returnTemplate\": {\n \"description\": \"The template of the return Doxygen line that is generated. If empty it won't get generated at all.\",\n \"type\": \"string\",\n \"default\": \"@return {type} \"\n },\n \"doxdocgen.generic.linesToGet\": {\n \"description\": \"How many lines the plugin should look for to find the end of the declaration. Please be aware that setting this value too low could improve the speed of comment generation by a very slim margin but the plugin also may not correctly detect all declarations or definitions anymore.\",\n \"type\": \"number\",\n \"default\": 20\n },\n \"doxdocgen.generic.authorName\": {\n \"markdownDescription\": \"Set the name of the author. Replaces `{author}`.\",\n \"type\": \"string\",\n \"default\": \"your name\"\n },\n \"doxdocgen.generic.authorEmail\": {\n \"markdownDescription\": \"Set the e-mail address of the author. Replaces `{email}`.\",\n \"type\": \"string\",\n \"default\": \"you@domain.com\"\n },\n \"doxdocgen.generic.authorTag\": {\n \"markdownDescription\": \"Set the style of the author tag and your name. Can template `{author}` and `{email}`.\",\n \"type\": \"string\",\n \"default\": \"@author {author} ({email})\"\n },\n \"doxdocgen.generic.dateTemplate\": {\n \"description\": \"The template for the date parameter in Doxygen.\",\n \"type\": \"string\",\n \"default\": \"@date {date}\"\n },\n \"doxdocgen.generic.dateFormat\": {\n \"description\": \"The format to use for the date.\",\n \"type\": \"string\",\n \"default\": \"YYYY-MM-DD\"\n },\n \"doxdocgen.generic.generateSmartText\": {\n \"description\": \"Decide if you want to get smart text for certain commands.\",\n \"type\": \"boolean\",\n \"default\": true\n },\n \"doxdocgen.generic.splitCasingSmartText\": {\n \"markdownDescription\": \"Decide if the values put into `{name}` should be split according to their casing.\",\n \"type\": \"boolean\",\n \"default\": true\n },\n \"doxdocgen.generic.order\": {\n \"markdownDescription\": \"The order to use for the comment generation. Values can be used multiple times. Valid values are `brief`, `empty`, `tparam`, `param`, `return`, `custom`, `author`, `date`, `version` and `copyright`.\",\n \"type\": [\n \"array\",\n \"string\"\n ],\n \"default\": [\n \"brief\",\n \"empty\",\n \"tparam\",\n \"param\",\n \"return\",\n \"custom\"\n ]\n },\n \"doxdocgen.generic.customTags\": {\n \"markdownDescription\": \"Custom tags to be added to the generic order. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.\",\n \"type\": [\n \"array\",\n \"string\"\n ],\n \"default\": []\n },\n \"doxdocgen.generic.filteredKeywords\": {\n \"description\": \"Array of keywords that should be removed from the input prior to parsing.\",\n \"type\": \"array\",\n \"default\": []\n },\n \"doxdocgen.generic.useGitUserName\": {\n \"markdownDescription\": \"Substitute `{author}` with `git config --get user.name`.\",\n \"type\": \"boolean\",\n \"default\": false\n },\n \"doxdocgen.generic.useGitUserEmail\": {\n \"markdownDescription\": \"Substitute `{email}` with `git config --get user.email`.\",\n \"type\": \"boolean\",\n \"default\": false\n },\n \"doxdocgen.generic.commandSuggestion\": {\n \"description\": \"Provide intellisense and snippet for doxygen commands\",\n \"type\": \"boolean\",\n \"default\": true\n },\n \"doxdocgen.generic.commandSuggestionAddPrefix\": {\n \"markdownDescription\": \"Add `\\\\` in doxygen command suggestion for better readability (need to enable commandSuggestion)\",\n \"type\": \"boolean\",\n \"default\": false\n }\n }\n }\n },\n \"icon\": \"images/icon.png\",\n \"keywords\": [\n \"cpp\",\n \"c++\",\n \"c\",\n \"Doxygen\"\n ],\n \"license\": \"SEE LICENSE IN LICENSE\",\n \"main\": \"./out/extension\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/cschlosser/doxdocgen.git\"\n },\n \"bugs\": {\n \"url\": \"https://github.com/cschlosser/doxdocgen/labels/bug\"\n },\n \"scripts\": {\n \"vscode:prepublish\": \"yarn compile\",\n \"compile\": \"tsc -p ./\",\n \"watch\": \"tsc -watch -p ./\",\n \"test\": \"yarn compile && node ./out/test/runTests.js\",\n \"cov\": \"yarn clean && nyc yarn test\",\n \"lint\": \"tslint -c tslint.json 'src/**/*.ts'\",\n \"clean\": \"rm -rf coverage .nyc_output out\"\n },\n \"dependencies\": {\n \"env-var\": \"^4.1.0\",\n \"moment\": \"^2.29.4\",\n \"opn\": \"^5.2.0\",\n \"simple-git\": \"^3.5.0\"\n },\n \"devDependencies\": {\n \"@istanbuljs/nyc-config-typescript\": \"0.1.3\",\n \"@types/mocha\": \"^5.2.7\",\n \"@types/node\": \"12.7.1\",\n \"@types/vscode\": \"^1.55.0\",\n \"decache\": \"^4.5.1\",\n \"glob\": \"^7.1.6\",\n \"handlebars\": \"^4.7.3\",\n \"minimist\": \">=1.2.6\",\n \"mocha\": \"^9.1.3\",\n \"nyc\": \"12.0.1\",\n \"remap-istanbul\": \"^0.13.0\",\n \"source-map-support\": \"^0.5.19\",\n \"ts-node\": \"^9.1.1\",\n \"tslint\": \"^5.20.0\",\n \"typescript\": \"^4.2.4\",\n \"vscode-test\": \"^1.5.2\",\n \"yargs-parser\": \">=13.1.2\"\n }\n}\n" }, { "path": "src/CodeParserController.ts", "content": "import {\n Disposable,\n Position,\n Range,\n TextDocumentContentChangeEvent,\n TextEditor,\n TextLine,\n window,\n workspace,\n} from \"vscode\";\nimport CodeParser from \"./Common/ICodeParser\";\nimport { Config } from \"./Config\";\nimport GitConfig from \"./GitConfig\";\nimport CppParser from \"./Lang/Cpp/CppParser\";\nimport { inComment } from \"./util\";\n/**\n *\n * Checks if the event matches the specified guidelines and if a parser exists for this language\n *\n * @export\n * @class CodeParserController\n */\nexport default class CodeParserController {\n private disposable: Disposable;\n private cfg: Config;\n private gitConfig: GitConfig;\n\n /**\n * Creates an instance of CodeParserController\n *\n * @memberOf CodeParserController\n */\n public constructor() {\n const subscriptions: Disposable[] = [];\n this.gitConfig = new GitConfig();\n\n // Hand off the event to the parser if a valid parser is found\n workspace.onDidChangeTextDocument((event) => {\n const activeEditor: TextEditor = window.activeTextEditor;\n if (activeEditor && event.document === activeEditor.document) {\n this.cfg = Config.ImportFromSettings();\n this.onEvent(activeEditor, event.contentChanges[0]);\n }\n }, this, subscriptions);\n\n this.disposable = Disposable.from(...subscriptions);\n }\n\n /**\n *\n * Disposes of the subscriptions\n *\n * @memberOf CodeParserController\n */\n public dispose() {\n this.disposable.dispose();\n }\n\n /***************************************************************************\n Implementation\n ***************************************************************************/\n\n private check(activeEditor: TextEditor, event: TextDocumentContentChangeEvent): boolean {\n if (activeEditor === undefined || activeEditor == null ||\n event === undefined || event.text == null) {\n return false;\n }\n const activeSelection: Position = activeEditor.selection.active;\n const activeLine: TextLine = activeEditor.document.lineAt(activeSelection.line);\n const activeChar: string = activeLine.text.charAt(activeSelection.character);\n const startsWith: boolean = event.text.startsWith(\"\\n\") || event.text.startsWith(\"\\r\\n\");\n\n // Check if enter was pressed. Note the !\n if (!((activeChar === \"\") && startsWith)) {\n return false;\n }\n\n // Check if currently in a comment block\n if (inComment(activeEditor, activeSelection.line)) {\n return false;\n }\n\n // Do not trigger when there's whitespace after the trigger sequence\n // tslint:disable-next-line:max-line-length\n const seq = \"[\\\\s]*(\" + this.cfg.C.triggerSequence.replace(/[\\-\\[\\]\\/\\{\\}\\(\\)\\*\\+\\?\\.\\\\\\^\\$\\|]/g, \"\\\\$&\") + \")$\";\n const match: RegExpMatchArray = activeLine.text.match(seq);\n\n if (match !== null) {\n const cont: string = match[1];\n return this.cfg.C.triggerSequence === cont;\n } else {\n return false;\n }\n }\n\n private onEvent(activeEditor: TextEditor, event: TextDocumentContentChangeEvent) {\n if (!this.check(activeEditor, event)) {\n return null;\n }\n\n const lang: string = activeEditor.document.languageId;\n let parser: CodeParser;\n\n switch (lang) {\n case \"c\":\n case \"cpp\":\n case \"cuda\":\n case \"cuda-cpp\":\n parser = new CppParser(this.cfg);\n break;\n default:\n // tslint:disable-next-line:no-console\n console.log(\"No comments can be generated for language: \" + lang);\n return null;\n }\n\n const currentPos: Position = window.activeTextEditor.selection.active;\n const startReplace: Position = new Position(\n currentPos.line,\n currentPos.character - this.cfg.C.triggerSequence.length,\n );\n\n const nextLineText: string = window.activeTextEditor.document.lineAt(startReplace.line + 1).text;\n const endReplace = new Position(currentPos.line + 1, nextLineText.length);\n\n parser.Parse(activeEditor).GenerateDoc(new Range(startReplace, endReplace), this.gitConfig);\n }\n}\n" }, { "path": "src/Common/ICodeParser.ts", "content": "import { TextEditor } from \"vscode\";\nimport { IDocGen } from \"./IDocGen\";\n\nexport default interface ICodeParser {\n /**\n * @param {TextEditor} activeEditor The open active Editor where the event came from\n */\n Parse(activeEditor: TextEditor): IDocGen;\n}\n" }, { "path": "src/Common/IDocGen.ts", "content": "import { Range } from \"vscode\";\nimport GitConfig from \"../GitConfig\";\n\nexport interface IDocGen {\n /**\n * @brief Generate documentation string and write it to the active editor\n * @param {Range} rangeToReplace Range to replace with the generated comment.\n */\n GenerateDoc(rangeToReplace: Range, gitConfig: GitConfig);\n}\n" }, { "path": "src/Config.ts", "content": "import { workspace } from \"vscode\";\n// tslint:disable:max-classes-per-file\n// tslint:disable:max-line-length\n\nclass C {\n public static getConfiguration() {\n return workspace.getConfiguration(\"doxdocgen.c\");\n }\n\n public triggerSequence: string = \"/**\";\n public firstLine: string = \"/**\";\n public commentPrefix: string = \" * \";\n public lastLine: string = \" */\";\n public getterText: string = \"Get the {name} object\";\n public setterText: string = \"Set the {name} object\";\n public factoryMethodText: string = \"Create a {name} object\";\n}\n\nclass Cpp {\n public static getConfiguration() {\n return workspace.getConfiguration(\"doxdocgen.cpp\");\n }\n\n public tparamTemplate: string = \"@tparam {param} \";\n public ctorText: string = \"Construct a new {name} object\";\n public dtorText: string = \"Destroy the {name} object\";\n}\n\nclass File {\n public static getConfiguration() {\n return workspace.getConfiguration(\"doxdocgen.file\");\n }\n\n public fileTemplate: string = \"@file {name}\";\n public copyrightTag: string[] = [\"@copyright Copyright (c) {year}\"];\n public versionTag: string = \"@version 0.1\";\n public customTag: string[] = [];\n public fileOrder: string[] = [\"brief\", \"empty\", \"file\", \"author\", \"date\"];\n}\n\nclass Generic {\n public static getConfiguration() {\n return workspace.getConfiguration(\"doxdocgen.generic\");\n }\n\n public includeTypeAtReturn: boolean = true;\n public boolReturnsTrueFalse: boolean = true;\n public briefTemplate: string = \"@brief {text}\";\n public paramTemplate: string = \"@param {param} \";\n public returnTemplate: string = \"@return {type} \";\n public linesToGet: number = 20;\n public authorName: string = \"your name\";\n public authorEmail: string = \"you@domain.com\";\n public authorTag: string = \"@author {author} ({email})\";\n public dateTemplate: string = \"@date {date}\";\n public dateFormat: string = \"YYYY-MM-DD\";\n public generateSmartText: boolean = true;\n public splitCasingSmartText: boolean = true;\n public order: string[] = [\"brief\", \"empty\", \"tparam\", \"param\", \"return\"];\n public customTags: string[] = [];\n public filteredKeywords: string[] = [];\n public useGitUserName: boolean = false;\n public useGitUserEmail: boolean = false;\n}\n\nexport class Config {\n public static ImportFromSettings(): Config {\n const values: Config = new Config();\n\n values.C.triggerSequence = C.getConfiguration().get(\"triggerSequence\", values.C.triggerSequence);\n values.C.firstLine = C.getConfiguration().get(\"firstLine\", values.C.firstLine);\n values.C.commentPrefix = C.getConfiguration().get(\"commentPrefix\", values.C.commentPrefix);\n values.C.lastLine = C.getConfiguration().get(\"lastLine\", values.C.lastLine);\n values.C.getterText = C.getConfiguration().get(\"getterText\", values.C.getterText);\n values.C.setterText = C.getConfiguration().get(\"setterText\", values.C.setterText);\n values.C.factoryMethodText = C.getConfiguration().get(\"factoryMethodText\", values.C.factoryMethodText);\n\n values.Cpp.tparamTemplate = Cpp.getConfiguration().get(\"tparamTemplate\", values.Cpp.tparamTemplate);\n values.Cpp.ctorText = Cpp.getConfiguration().get(\"ctorText\", values.Cpp.ctorText);\n values.Cpp.dtorText = Cpp.getConfiguration().get(\"dtorText\", values.Cpp.dtorText);\n\n values.File.fileTemplate = File.getConfiguration().get(\"fileTemplate\", values.File.fileTemplate);\n values.File.versionTag = File.getConfiguration().get(\"versionTag\", values.File.versionTag);\n values.File.copyrightTag = File.getConfiguration().get(\"copyrightTag\", values.File.copyrightTag);\n values.File.customTag = File.getConfiguration().get(\"customTag\", values.File.customTag);\n values.File.fileOrder = File.getConfiguration().get(\"fileOrder\", values.File.fileOrder);\n\n values.Generic.includeTypeAtReturn = Generic.getConfiguration().get(\"includeTypeAtReturn\", values.Generic.includeTypeAtReturn);\n values.Generic.boolReturnsTrueFalse = Generic.getConfiguration().get(\"boolReturnsTrueFalse\", values.Generic.boolReturnsTrueFalse);\n values.Generic.briefTemplate = Generic.getConfiguration().get(\"briefTemplate\", values.Generic.briefTemplate);\n values.Generic.paramTemplate = Generic.getConfiguration().get(\"paramTemplate\", values.Generic.paramTemplate);\n values.Generic.returnTemplate = Generic.getConfiguration().get(\"returnTemplate\", values.Generic.returnTemplate);\n values.Generic.linesToGet = Generic.getConfiguration().get(\"linesToGet\", values.Generic.linesToGet);\n values.Generic.authorTag = Generic.getConfiguration().get(\"authorTag\", values.Generic.authorTag);\n values.Generic.authorName = Generic.getConfiguration().get(\"authorName\", values.Generic.authorName);\n values.Generic.authorEmail = Generic.getConfiguration().get(\"authorEmail\", values.Generic.authorEmail);\n values.Generic.dateTemplate = Generic.getConfiguration().get(\"dateTemplate\", values.Generic.dateTemplate);\n values.Generic.dateFormat = Generic.getConfiguration().get(\"dateFormat\", values.Generic.dateFormat);\n values.Generic.generateSmartText = Generic.getConfiguration().get(\"generateSmartText\", values.Generic.generateSmartText);\n values.Generic.splitCasingSmartText = Generic.getConfiguration().get(\"splitCasingSmartText\", values.Generic.splitCasingSmartText);\n values.Generic.order = Generic.getConfiguration().get(\"order\", values.Generic.order);\n values.Generic.customTags = Generic.getConfiguration().get(\"customTags\", values.Generic.customTags);\n values.Generic.filteredKeywords = Generic.getConfiguration().get(\"filteredKeywords\", values.Generic.filteredKeywords);\n values.Generic.useGitUserName = Generic.getConfiguration().get(\"useGitUserName\", values.Generic.useGitUserName);\n values.Generic.useGitUserEmail = Generic.getConfiguration().get(\"useGitUserEmail\", values.Generic.useGitUserEmail);\n\n return values;\n }\n\n public readonly paramTemplateReplace: string = \"{param}\";\n public readonly typeTemplateReplace: string = \"{type}\";\n public readonly nameTemplateReplace: string = \"{name}\";\n public readonly authorTemplateReplace: string = \"{author}\";\n public readonly emailTemplateReplace: string = \"{email}\";\n public readonly dateTemplateReplace: string = \"{date}\";\n public readonly yearTemplateReplace: string = \"{year}\";\n public readonly textTemplateReplace: string = \"{text}\";\n\n public C: C;\n public Cpp: Cpp;\n public File: File;\n public Generic: Generic;\n\n constructor() {\n this.C = new C();\n this.Cpp = new Cpp();\n this.File = new File();\n this.Generic = new Generic();\n }\n}\n" }, { "path": "src/DoxygenCompletionItemProvider.ts", "content": "import * as vscode from \"vscode\";\nimport { inComment } from \"./util\";\n\n// tslint:disable:max-line-length\n\n/*https://github.com/cschlosser/doxdocgen/issues/30 */\nexport default class DoxygenCompletionItemProvider implements vscode.CompletionItemProvider {\n /**\n * commands are a tuple of \n */\n public static readonly commands: Array<[string, string, string]> = [\n /*Special commands */\n [\"a\", \"${1:word}\", \"Display `` in italics\"],\n [\"arg\", \"${1:item-description}\", \"Generate a simple, non-nested list of arguments\"],\n [\"b\", \"${1:word}\", \"Display `` in bold\"],\n [\"c\", \"${1:word}\", \"Display `` using a typewriter font\"],\n [\"code\", \"{.${1:language-id}}\\n${2:code}\\n@endcode\", \"Starts a block of code\"], // TODO: match end block symbol with trigger character\n [\"copydoc\", \"${1:link-object}\", \"Copy a documentation block from the object specified by `` and paste it at the location of the command. The link object can point to a member (of a class, file or group), a class, a namespace, a group, a page, or a file. If the member is overloaded, you should specify the argument types explicitly\"],\n [\"copybrief\", \"${1:link-object}\", \"Work in a similar way as `@copydoc` but will only copy the brief description, not the detailed documentation\"],\n [\"copydetails\", \"${1:link-object}\", \"Work in a similar way as `@copydoc` but will only copy the detailed documentation, not the brief description\"],\n [\"docbookonly\", \"$1\\n@enddocbookonly\", \"Start a block of text that only will be verbatim included in the generated DocBook documentation and tagged with `` in the generated XML output\"],\n [\"emoji\", \":${1:name}:\", \"Produce an emoji character given its name\"],\n [\"startuml\", \"${1:file} \\\"${2:caption}\\\" ${3:size_indication}=${4:size}\\n@enduml\", \"Start a text fragment which should contain a valid description of a PlantUML diagram\"],\n [\"e\", \"${1:word}\", \"Display `` in italics\"],\n [\"em\", \"${1:word}\", \"Display `` in italics\"],\n [\"endcode\", \"\", \"End a block of code\"],\n [\"enddocbookonly\", \"\", \"End a block of text that was started with `@docbookonly` command\"],\n [\"enduml\", \"\", \"End a block that was started with `@startuml`\"],\n [\"endhtmlonly\", \"\", \"End a block of text that was started with a `@htmlonly` command\"],\n [\"endlatexonly\", \"\", \"End a block of text that was started with a `@latexonly` command\"],\n [\"endmanonly\", \"\", \"End a block of text that was started with a `@manonly` command\"],\n [\"endxmlonly\", \"\", \"End a block of text that was started with a `@xmlonly` command\"],\n [\"htmlonly\", \"$1\\n@endhtmlonly\", \"Start a block of text that only will be verbatim included in the generated HTML documentation and tagged with `` in the generated XML output\"],\n [\"image\", \"${1|html,latex,docbook,rtf|} ${2:file} ${3:caption} ${4:${5:size_inidication}=${6:size}}\", \"Insert an image into the documentation\"],\n [\"latexonly\", \"$1\\n@endlatexonly\", \"Start a block of text that only will be verbatim included in the generated LATEX documentation and tagged with `` in the generated XML output\"],\n [\"manonly\", \"$1\\n@manonly\", \"Start a block of text that only will be verbatim included in the generated MAN documentation and tagged with `` in the generated XML output\"],\n [\"li\", \"${1:item-description}\", \"Generate a simple, non-nested list of arguments\"],\n [\"n\", \"\", \"Force a new line\"],\n [\"verbatim\", \"$1\\n@verbatim\", \"Start a block of text that will be verbatim included in the documentation\"],\n [\"xmlonly\", \"$1\\n@endxmlonly\", \"Start a block of text that will be verbatim included in the documentation\"],\n /*Section indicators */\n [\"attention\", \"${1:attention text}\", \"Start a paragraph where a message that needs attention may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@attention` commands will be joined into a single paragraph. The `@attention` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"author\", \"${1:author}\", \"Starts a paragraph where one or more author names may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@author` commands will be joined into a single paragraph. Each author description will start a new line. Alternatively, one `@author` command may mention several authors. The `@author` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"authors\", \"${1:list of authors}\", \"Equivalent to `@author`\"],\n [\"brief\", \"${1:brief description}\", \"Starts a paragraph that serves as a brief description. For classes and files the brief description will be used in lists and at the start of the documentation page. For class and file members, the brief description will be placed at the declaration of the member and prepended to the detailed description. A brief description may span several lines (although it is advised to keep it brief!). A brief description ends when a blank line or another sectioning command is encountered. If multiple `@brief` commands are present they will be joined.\"],\n [\"bug\", \"${1:bug description}\", \"Starts a paragraph where one or more bugs may be reported. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@bug` commands will be joined into a single paragraph. Each bug description will start on a new line. Alternatively, one `@bug` command may mention several bugs. The `@bug` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"cond\", \"${1:section label}\", \"Starts a conditional section that ends with a corresponding `@endcond` command, which is typically found in another comment block\"],\n [\"copyright\", \"${1:copyright description}\", \"Starts a paragraph where the copyright of an entity can be described. This paragraph will be indented.\"],\n [\"date\", \"${1:date description}\", \"Starts a paragraph where one or more dates may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@date` commands will be joined into a single paragraph. Each date description will start on a new line. Alternatively, one `@date` command may mention several dates. The `@date` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"deprecated\", \"${1:description}\", \"Starts a paragraph indicating that this documentation block belongs to a deprecated entity\"],\n [\"details\", \"${1:description}\", \"Just like `@brief` starts a brief description, `@details` starts the detailed description. You can also start a new paragraph (blank line) then the `@details` command is not needed.\"],\n [\"noop\", \"\", \"All the text, including the command, till the end of the line is ignored\"],\n [\"else\", \"\", \"Starts a conditional section if the previous conditional section was not enabled. The previous section should have been started with a `@if`, `@ifnot`, or `@elseif` command.\"],\n [\"elseif\", \"${1:section-label}\", \"Starts a conditional documentation section if the previous section was not enabled. A conditional section is disabled by default. To enable it you must put the section-label after the ENABLED_SECTIONS tag in the configuration file. The section label can be a logical expression build of section names, round brackets, && (AND), || (OR) and ! (NOT). Conditional blocks can be nested. A nested section is only enabled if all enclosing sections are enabled as well.\"],\n [\"endcond\", \"\", \"Ends a conditional section that was started by `@cond`.\"],\n [\"endif\", \"\", \"Ends a conditional section that was started by `@if` or `@ifnot` For each `@if` or `@ifnot` one and only one matching `@endif` must follow.\"],\n [\"exception\", \"${1:exception-object} ${2:exception description}\", \"Starts an exception description for an exception object with name ``. Followed by a description of the exception. The existence of the exception object is not checked. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent @exception commands will be joined into a single paragraph. Each exception description will start on a new line. The `@exception` description ends when a blank line or some other sectioning command is encountered\"],\n [\"if\", \"${1:section-label}\\n$2\\n@endif\", \"Starts a conditional documentation section. The section ends with a matching `@endif` command. A conditional section is disabled by default. To enable it you must put the section-label after the ENABLED_SECTIONS tag in the configuration file. The section label can be a logical expression build of section names, round brackets, && (AND), || (OR) and!(NOT). If you use an expression you need to wrap it in round brackets, i.e. `@cond(!LABEL1 && LABEL2)`.\"],\n [\"ifnot\", \"${1:section-label}\", \"Starts a conditional documentation section. The section ends with a matching `@endif` command. This conditional section is enabled by default. To disable it you must put the section-label after the ENABLED_SECTIONS tag in the configuration file. The section label can be a logical expression build of section names, round brackets, && (AND), || (OR) and ! (NOT).\"],\n [\"invariant\", \"${1:description of invariant}\", \"Starts a paragraph where the invariant of an entity can be described. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@invariant` commands will be joined into a single paragraph. Each invariant description will start on a new line. Alternatively, one `@invariant` command may mention several invariants. The `@invariant` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"note\", \"${1:text}\", \"Starts a paragraph where a note can be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@note` commands will be joined into a single paragraph. Each note description will start on a new line. Alternatively, one `@note` command may mention several notes. The `@note` command ends when a blank line or some other sectioning command is encountered\"],\n [\"par\", \"${1:paragraph title}\\n$2\", \"If a paragraph title is given this command starts a paragraph with a user defined heading. The heading extends until the end of the line. The paragraph following the command will be indented. If no paragraph title is given this command will start a new paragraph. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. The `@par` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"param\", \"${1:parameter-name} ${2:description}\", \"Starts a parameter description for a function parameter with name ``, followed by a description of the parameter. The existence of the parameter is checked and a warning is given if the documentation of this (or any other) parameter is missing or not present in the function declaration or definition. Multiple adjacent `@param` commands will be joined into a single paragraph. Each parameter description will start on a new line. The `@param` description ends when a blank line or some other sectioning command is encountered. Note that you can also document multiple parameters with a single `@param` command using a comma separated list.\"],\n [\"parblock\", \"\\n$1\\n@endparblock\", \"For commands that expect a single paragraph as argument (such as `@par`, `@param` and `@warning`), the `@parblock` command allows to start a description that covers multiple paragraphs, which then ends with `@endparblock`.\"],\n [\"endparblock\", \"\", \"This ends a block of paragraphs started with `@parblock`.\"],\n [\"tparam\", \"${1:template-parameter-name} ${2:description}\", \"Starts a template parameter for a class or function template parameter with name ``, followed by a description of the template parameter.\"],\n [\"post\", \"${1:description of the postcondition}\", \"Starts a paragraph where the postcondition of an entity can be described. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@post` commands will be joined into a single paragraph. Each postcondition will start on a new line. Alternatively, one `@post` command may mention several postconditions. The `@post` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"pre\", \"${1:description of the precondition}\", \"Starts a paragraph where the precondition of an entity can be described. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@pre` commands will be joined into a single paragraph. Each precondition will start on a new line. Alternatively, one `@pre` command may mention several preconditions. The `@pre` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"remark\", \"${1:remark text}\", \"Starts a paragraph where one or more remarks may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@remark` commands will be joined into a single paragraph. Each remark will start on a new line. Alternatively, one `@remark` command may mention several remarks. The `@remark` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"remarks\", \"${1:remark text}\", \"Equivalent to `@remark`\"],\n [\"result\", \"${1:description of the result value}\", \"Equivalent to `@return`\"],\n [\"return\", \"${1:description of the return value}\", \"Starts a return value description for a function. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@return` commands will be joined into a single paragraph. The `@return` description ends when a blank line or some other sectioning command is encountered\"],\n [\"returns\", \"${1:description of the return value}\", \"Equivalent to `@return`\"],\n [\"retval\", \"${1:return value} ${2:description}\", \"Starts a description for a function's return value with name ``, followed by a description of the return value. The text of the paragraph that forms the description has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@retval` commands will be joined into a single paragraph. Each return value description will start on a new line. The `@retval` description ends when a blank line or some other sectioning command is encountered.\"],\n [\"sa\", \"${1:reference}\", \"Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL may be specified. Two names joined by either `::` or `#` are understood as referring to a class and one of its members. One of several overloaded methods or constructors may be selected by including a parenthesized list of argument types after the method name.\"],\n [\"see\", \"${1:reference}\", \"Equivalent to `@sa`\"],\n [\"short\", \"${1:short description\", \"Equivalent to `@brief`\"],\n [\"since\", \"${1:text}\", \"This command can be used to specify since when (version or time) an entity is available. The paragraph that follows `@since` does not have any special internal structure. All visual enhancement commands may be used inside the paragraph. The `@since` description ends when a blank line or some other sectioning command is encountered.\"],\n [\"test\", \"${1:paragraph describing a test case\", \"This command can be used to specify since when (version or time) an entity is available. The paragraph that follows `@since` does not have any special internal structure. All visual enhancement commands may be used inside the paragraph. The `@since` description ends when a blank line or some other sectioning command is encountered.\"],\n [\"throw\", \"${1:exception-object} ${2:exception description}\", \"Equivalent to `@exception`\"],\n [\"throws\", \"${1:exception-object} ${2:exception description}\", \"Equivalent to `@exception`\"],\n [\"todo\", \"${1:paragraph describing what is to be done}\", \"Starts a paragraph where a `TODO` item is described. The description will also add an item to a separate `TODO` list. The two instances of the description will be cross-referenced. Each item in the `TODO` list will be preceded by a header that indicates the origin of the item.\"],\n [\"version\", \"${1:version number}\", \"Starts a paragraph where one or more version strings may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@version` commands will be joined into a single paragraph. Each version description will start on a new line. Alternatively, one `@version` command may mention several version strings. The `@version` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"warning\", \"${1:warning message}\", \"Starts a paragraph where one or more warning messages may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent `@warning` commands will be joined into a single paragraph. Each warning description will start on a new line. Alternatively, one `@warning` command may mention several warnings. The `@warning` command ends when a blank line or some other sectioning command is encountered.\"],\n [\"xrefitem\", \"${1:key} \\\"${2:heading}\\\" \\\"${3:list title}\\\" ${4:text}\", \"This command is a generalization of commands such as `@todo` and `@bug`. It can be used to create user-defined text sections which are automatically cross-referenced between the place of occurrence and a related page, which will be generated. On the related page all sections of the same type will be collected.\"],\n /*Commands to create links */\n [\"addindex\", \"${1:text}\", \"This command adds `text` to the LATEX, DocBook and RTF index.\"],\n [\"anchor\", \"${1:word}\", \"This command places an invisible, named anchor into the documentation to which you can refer with the `@ref` command.\"],\n [\"cite\", \"${1:label}\", \"Adds a bibliographic reference in the text and in the list of bibliographic references. The `