first commit

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-react", "@babel/preset-env"]
+}

.eslintrc.js

@@ -0,0 +1,42 @@
+module.exports = {
+    'env': {
+        'es6': true,
+        'node': true,
+        'mocha': true
+    },
+    "extends": [
+        "plugin:vue/essential",
+        "eslint:recommended",
+        // 'airbnb'
+    ],
+    'parserOptions': {
+        'ecmaVersion': 2015,
+        'sourceType': 'module'
+    },
+    'rules': {
+        'indent': ['error', 2],
+        'linebreak-style': ['error', 'unix'],
+        'quotes': ['error', 'single'],
+        'semi': ['error', 'never'],
+        'import/no-unresolved': 'off',
+        'no-underscore-dangle': 'off',
+        'guard-for-in': 'off',
+        'no-restricted-syntax': 'off',
+        'no-await-in-loop': 'off',
+        'object-curly-newline': 'off'
+    },
+    overrides: [
+        {
+          files: ['*-test.js', '*.spec.js'],
+          rules: {
+            'no-unused-expressions': 'off',
+            'func-names': 'off',
+            'prefer-arrow-callback': 'off',
+            "react/jsx-filename-extension": 'off'
+          }
+        }
+    ],
+    globals: {
+        'expect': true,
+    }
+}

.gitignore

@@ -0,0 +1,95 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# IDEs and editors
+.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+.sass-cache
+connect.lock
+typings
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+# Lerna
+lerna-debug.log
+
+# System Files
+.DS_Store
+Thumbs.db
+
+.cache
+
+docs

.npmignore

@@ -0,0 +1 @@
+./readme

.travis.yml

@@ -0,0 +1,15 @@
+language: node_js
+node_js:
+- '8'
+deploy:
+  # tag: 'beta'
+  provider: npm
+  email: [email protected]
+  api_key:
+    secure: XccQzN+oE24xUOCuwuYjLwZOwslkq0Woxp6gdL+AL9Hw5ao88N79tGkC26EabPPD3OFwRddrfLpQROJTBO1OI9nMq6FmdWtrMpv9xo1npII6shxbCvl18/NB+uqPbhlPDxcwzULr5kYnhXDxEvGYkowOFAqJoa7f+QToMxSS7ICEYUCubfDNkF4d+U+yjlKRIKKURI1PO/0CsnnwQtEStVdk8Lr9UrpV4EUmBV+7NLtW9NcBKfOQt7sGQXR/HiXFzka5kIj3tDW0uhZvZykRHU3j6LxDJhCReBPAaW+S1yOB5BsLaYpo1bOzhhBl4FbPYtDZhW1P6f5gQ+VU3/EvLBxKFBBjeGQAxS6v7dCvHdR4l50LWK7b/up2WoWgew+b9tLuV8hRUchtusFNE8UVNGpsWRGGS5bziK/A1CwynbViuAR3jl5qIByzSWDYCsJ3i31Ptb6C/uq5rKOtaLmtxQeF7uFUUm1tJPe/7Kr1DizAQMccxnL+ursjPNbcDUhMT6f87OUhK8jk0oU9aPBWu+65+d105wVxTxFJwful4kIziS4E/261hPzavSYTXA8ki6Vd0w4849nHMGWM8kZgqC6inS4iYzFJkrGhWSjxFCUmZyuAA3yHizlYS7eINhgK8wqk2XR/tUYLkfSPW6xmb9xDircqgdxzv8g4nBXCdx4=
+  on:
+    tags: true
+    repo: SoftwareBrothers/better-docs
+notifications:
+  slack:
+    secure: kuyxSwmyGhCjGRMzbgxCDiOSUzA9m+/eOUgRhIB0CNyWC3XL5ZstB7n1zA8J1bFe80TxFvHawhkT0WWoS0LVhDj7NRxZxBNHVZFKtM1iAU5zaf4s/x6JNA0S6w78240yJPOW1ViwX98jqSGGmu0uaq+8DvLpC1gdSDa35gHSq0F3N5VFqzmpbqMY9OkhhcepU90uP4jlwS2T3mp2s5MML7Z26uia8Q5QfLAMaaC7zNYS0jZPj+37cwTzt73u9Dxc1NYMg6mCsD8nmV6Kij5dBLJlc3rRIOR3mP0THS6BykEdTFI51Gl1bNCvPntrE/IUOtBKoI8KcTXAzxXQZrC9tWRYE+VeaTiwmrjAv2CkI+XOsJldJGE3nsKQ59YH7gk4XkRfDMjzRpyqMGKA3fndAh8Yi60tojoJBCF4HAUTqcmRh/RFnus8kceWIhy56Ln1BwUGIXAhlc0WKkKkPIDo1UXoOaC9sRzWuK6Vd33woRlSsP3FGPKCMqbxbn9f9OJ0c/0oyRlOoR0Aigggnkejs5QpitBg4xFN83nsy4E2L3K1fMQb6ZbJjEgmydcDHEPSRzWLC1LsaEiQRFCFKuGtgoTgWo+/hzeG4y4SCl+9v5TtLdZAoPmU+0pQc863LTEyk+Oi9x7AXNoYJYyXjkcwW654D6fykHB2WUWH5a3PEtc=

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Yarn test",
+      "program": "${workspaceRoot}/node_modules/.bin/mocha",
+      "args": [
+          "--recursive", "./*spec.js", "./typescript/*spec.js",
+      ],
+      "internalConsoleOptions": "openOnSessionStart"
+  }
+  ]
+}

CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Changelog maintained after version 1.3.0
+
+## [1.4.7] - 2019-10-18
+
+### Fixed
+
+- fixed problem of one line comments of types and interfaces [#40]
+
+
+## [1.4.6] - 2019-10-17
+
+### Fixed
+
+- fix problem with the methods defined directly in the interface (related to [#39])
+
+## [1.4.5] - 2019-10-16
+
+### Fixed
+
+- fix problem treating not react files as react (related to [#39])
+
+## [1.4.4] - 2019-10-16
+
+### Fixed
+
+- fix problem with Array defined as {attribute: type}[] [#39]
+
+## [1.4.4] - 2019-10-11
+
+### Added
+- support for documenting class members in typescript
+- current item in sidebar is selected
+- hash with the link to the documentation element
+
+## [1.4.0] - 2019-10-03
+
+### Added
+- Add typescript support
+
+## [1.3.3] - 2019-09-25
+### Fixed
+- fixed vue components preview
+- attempt to fix error with paths on windows
+
+## [1.3.2] - 2019-09-25
+### Added
+- add the ability to document vue components with dash in a name
+### Fixed
+- fix @classdesc tag for components
+
+## [1.3.1] - 2019-09-25
+### Added
+- add ability to document both react and vue components
+- temporarily fix height issue on react components
+- add typedef plugin
+### Fixed
+- fix warning with className

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 SoftwareBrothers.co
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.