Ai

.dockerignore

@@ -0,0 +1,25 @@
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/bin
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

.eslintrc.js

@@ -0,0 +1,162 @@
+module.exports = {
+    env: {
+        es6: true,
+        node: true,
+    },
+    extends: [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "prettier",
+    ],
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        project: "tsconfig.json",
+        sourceType: "module",
+    },
+    plugins: [
+        "eslint-plugin-import",
+        "eslint-plugin-jsdoc",
+        "eslint-plugin-prefer-arrow",
+        "@typescript-eslint",
+    ],
+    rules: {
+        "@typescript-eslint/adjacent-overload-signatures": "error",
+        "@typescript-eslint/array-type": [
+            "error",
+            {
+                default: "array",
+            },
+        ],
+        "@typescript-eslint/ban-types": [
+            "error",
+            {
+                types: {
+                    Object: {
+                        message: "Avoid using the `Object` type. Did you mean `object`?",
+                    },
+                    Function: {
+                        message:
+                            "Avoid using the `Function` type. Prefer a specific function type, like `() => void`.",
+                    },
+                    Boolean: {
+                        message: "Avoid using the `Boolean` type. Did you mean `boolean`?",
+                    },
+                    Number: {
+                        message: "Avoid using the `Number` type. Did you mean `number`?",
+                    },
+                    String: {
+                        message: "Avoid using the `String` type. Did you mean `string`?",
+                    },
+                    Symbol: {
+                        message: "Avoid using the `Symbol` type. Did you mean `symbol`?",
+                    },
+                },
+            },
+        ],
+        "@typescript-eslint/consistent-type-assertions": "error",
+        "@typescript-eslint/dot-notation": "error",
+        "@typescript-eslint/member-delimiter-style": [
+            "error",
+            {
+                multiline: {
+                    delimiter: "semi",
+                    requireLast: true,
+                },
+                singleline: {
+                    delimiter: "semi",
+                    requireLast: false,
+                },
+            },
+        ],
+        "@typescript-eslint/naming-convention": "off",
+        "@typescript-eslint/no-empty-function": "error",
+        "@typescript-eslint/no-empty-interface": "error",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-misused-new": "error",
+        "@typescript-eslint/no-namespace": "error",
+        "@typescript-eslint/no-parameter-properties": "off",
+        "@typescript-eslint/no-shadow": [
+            "error",
+            {
+                hoist: "all",
+            },
+        ],
+        "@typescript-eslint/no-unused-expressions": "error",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/no-var-requires": "error",
+        "@typescript-eslint/prefer-for-of": "error",
+        "@typescript-eslint/prefer-function-type": "error",
+        "@typescript-eslint/prefer-namespace-keyword": "error",
+        "@typescript-eslint/semi": ["error"],
+        "@typescript-eslint/triple-slash-reference": [
+            "error",
+            {
+                path: "always",
+                types: "prefer-import",
+                lib: "always",
+            },
+        ],
+        "@typescript-eslint/unified-signatures": "error",
+        complexity: "off",
+        "constructor-super": "error",
+        "dot-notation": "error",
+        eqeqeq: ["off", "always"],
+        "guard-for-in": "error",
+        "id-denylist": [
+            "error",
+            "any",
+            "Number",
+            "number",
+            "String",
+            "string",
+            "Boolean",
+            "boolean",
+            "Undefined",
+            "undefined",
+        ],
+        "id-match": "error",
+        "import/order": "off",
+        "jsdoc/check-alignment": "error",
+        "jsdoc/check-indentation": "error",
+        "jsdoc/newline-after-description": "error",
+        "max-classes-per-file": ["error", 1],
+        "new-parens": "error",
+        "no-bitwise": "error",
+        "no-caller": "error",
+        "no-cond-assign": "error",
+        "no-console": "off",
+        "no-debugger": "error",
+        "no-empty": "error",
+        "no-empty-function": "error",
+        "no-eval": "error",
+        "no-fallthrough": "off",
+        "no-invalid-this": "off",
+        "no-new-wrappers": "error",
+        "no-shadow": "error",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "error",
+        "no-undef-init": "error",
+        "no-underscore-dangle": "error",
+        "no-unsafe-finally": "error",
+        "no-unused-expressions": "error",
+        "no-unused-labels": "error",
+        "no-use-before-define": "off",
+        "no-var": "error",
+        "object-shorthand": "error",
+        "one-var": ["error", "never"],
+        "prefer-arrow/prefer-arrow-functions": "off",
+        "prefer-const": "error",
+        radix: "error",
+        semi: "error",
+        "space-before-function-paren": "off",
+        "spaced-comment": [
+            "error",
+            "always",
+            {
+                markers: ["/"],
+            },
+        ],
+        "use-isnan": "error",
+        "valid-typeof": "off",
+    },
+};

.github/workflows/test_and_publish.yml

@@ -0,0 +1,66 @@
+name: Test autoDocstring
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - master
+jobs:
+    unit_tests:
+        runs-on: "${{ matrix.os }}"
+        strategy:
+            matrix:
+                os: [ubuntu-latest, macos-latest, windows-latest]
+                node: [18]
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: "${{ matrix.node-version }}"
+                  cache: "npm"
+            - run: npm install
+            - run: npm run vscode:prepublish
+            - run: npm run unit_test
+
+    integration_tests:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: 18
+                  cache: "npm"
+            - run: npm install
+            - run: npm run prepare_integration_tests
+            - uses: GabrielBB/xvfb-action@v1
+              with:
+                  options: -screen 0 1024x768x24
+                  run: npm run integration_test
+    publish:
+        needs:
+            - unit_tests
+            - integration_tests
+        if: startsWith(github.event.ref, 'refs/tags/v')
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: 18
+                  cache: "npm"
+            - run: npm ci
+            - name: GitHub Release
+              uses: softprops/action-gh-release@v1
+              with:
+                  generate_release_notes: true
+                  body: |
+                      # Summary
+                      See [changelog](https://github.com/NilsJPWerner/autoDocstring/blob/master/CHANGELOG.md)
+                  name: ${{ github.ref_name }}
+                  fail_on_unmatched_files: true
+            - name: Publish to Visual Studio Marketplace
+              uses: HaaLeo/publish-vscode-extension@v1
+              with:
+                  pat: ${{ secrets.VS_MARKETPLACE_TOKEN }}
+                  registryUrl: https://marketplace.visualstudio.com

.vscode/launch.json

@@ -1,6 +1,21 @@
 {
     "version": "0.2.0",
 	"configurations": [
+		{
+			"name": "Attach to Edge",
+			"port": 9222,
+			"request": "attach",
+			"type": "msedge",
+			"webRoot": "${workspaceFolder}"
+		},
+
+		{
+			"name": "Launch Chrome",
+			"request": "launch",
+			"type": "chrome",
+			"url": "http://localhost:8080",
+			"webRoot": "${workspaceFolder}"
+		},
 		{
 			"name": "Run Extension",
 			"type": "extensionHost",

.vscode/tasks.json

@@ -14,5 +14,12 @@
 				"isDefault": true
 			}
 		},
+		{
+			"type": "npm",
+			"script": "lint",
+			"problemMatcher": ["$eslint-stylish"],
+			"label": "npm: lint",
+			"detail": "eslint -c .eslintrc.js --ext .ts src/"
+		}
 	]
 }

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+-   Added doxygen format support ([#120](https://github.com/NilsJPWerner/autoDocstring/issues/120)) (@daluar @PhilipNelson5)
+-   Disable HTML-escaping behavior globally ([#235](https://github.com/NilsJPWerner/autoDocstring/issues/235)) (@PhilipNelson5)
+
 [All Changes](https://github.com/NilsJPWerner/autoDocstring/compare/v0.6.1...master)
 
 ## [0.6.1](https://github.com/NilsJPWerner/autoDocstring/tree/v0.6.1) - 2022-02-15

Dockerfile

@@ -0,0 +1,23 @@
+FROM openjdk:8-jdk-alpine
+VOLUME /tmp
+ARG JAVA_OPTS
+ENV JAVA_OPTS=$JAVA_OPTS
+COPY autodocstring.jar autodocstring.jar
+EXPOSE 3000
+ENTRYPOINT exec java $JAVA_OPTS -jar autodocstring.jar
+# For Spring-Boot project, use the entrypoint below to reduce Tomcat startup time.
+#ENTRYPOINT exec java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -jar autodocstring.jar
+FROM openjdk:8-jdk-alpine
+VOLUME /tmp
+ARG JAVA_OPTS
+ENV JAVA_OPTS=$JAVA_OPTS
+COPY autodocstring.jar autodocstring.jar
+EXPOSE 3000
+ENTRYPOINT exec java $JAVA_OPTS -jar autodocstring.jar
+# For Spring-Boot project, use the entrypoint below to reduce Tomcat startup time.
+#ENTRYPOINT exec java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -jar autodocstring.jar
+JAVA_OPTS 
+SCRIPT
+
+ENTRYPOINT [ "
+ENV  =value" ]

README.md

@@ -1,6 +1,6 @@
-[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/njpwerner.autodocstring.svg)](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring)
-[![Rating](https://vsmarketplacebadge.apphb.com/rating-short/njpwerner.autodocstring.svg)](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring&ssr=false#review-details)
-[![Build Status](https://github.com/NilsJPWerner/autoDocstring/actions/workflows/test.yml/badge.svg)](https://github.com/NilsJPWerner/autoDocstring/actions/workflows/test.yml)
+[![Installs](https://vsmarketplacebadges.dev/installs-short/njpwerner.autodocstring.svg)](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring)
+[![Rating](https://vsmarketplacebadges.dev/rating-short/njpwerner.autodocstring.svg)](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring&ssr=false#review-details)
+[![Build Status](https://github.com/NilsJPWerner/autoDocstring/actions/workflows/test_and_publish.yml/badge.svg)](https://github.com/NilsJPWerner/autoDocstring/actions/workflows/test_and_publish.yml)
 [![Github Sponsorship](https://img.shields.io/badge/sponsor-5A5A5A?style=flat&logo=GitHub-Sponsors)](https://github.com/sponsors/NilsJPWerner)
 
 # autoDocstring: VSCode Python Docstring Generator
@@ -20,12 +20,13 @@ Visual Studio Code extension to quickly generate docstrings for python functions
 
 To turn off type generation in docstrings use the `-notypes` template of the desired format. The docBlockr format is a typed version of PEP0257.
 
+-   [docBlockr](docs/docblockr.md)
+-   [doxygen](docs/doxygen.md)
 -   [google](docs/google.md)
--   [sphinx](docs/sphinx.md)
 -   [numpy](docs/numpy.md)
--   [docBlockr](docs/docblockr.md)
 -   [one-line-sphinx](docs/one-line-sphinx.md)
 -   [pep257](docs/pep257.md)
+-   [sphinx](docs/sphinx.md)
 
 ## Usage
 

docker-compose.debug.yml

@@ -0,0 +1,13 @@
+version: '3.4'
+
+services:
+  autodocstring:
+    image: autodocstring
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    environment:
+      JAVA_OPTS: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005,quiet=y
+    ports:
+      - 3000:3000
+      - 5005:5005

docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3.4'
+
+services:
+  autodocstring:
+    image: autodocstring
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    ports:
+      - 3000:3000

docs/doxygen.md

@@ -0,0 +1,19 @@
+# Doxygen Docstring Format
+
+```python
+def abc(a: int, c = [1,2]):
+    """!
+    @brief _summary_
+
+    @param a (int): _description_
+    @param c (list, optional): _description_. Defaults to [1,2].
+
+    @return (_type_): _description_
+
+    @exception AssertionError: _description_
+    """
+    if a > 10:
+        raise AssertionError("a is more than 10")
+
+    return c
+```