├── .editorconfig ├── .github └── workflows │ └── validating.yml ├── .gitignore ├── .npmignore ├── .npmrc ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── SECURITY.md ├── hooks.md ├── lib ├── errors │ ├── file_error.js │ ├── parameter_error.js │ ├── parser_error.js │ └── worker_error.js ├── filter.js ├── filters │ ├── api_error.js │ ├── api_header.js │ ├── api_param.js │ └── api_success.js ├── index.js ├── languages │ ├── clj.js │ ├── coffee.js │ ├── default.js │ ├── erl.js │ ├── ex.js │ ├── lua.js │ ├── pm.js │ ├── py.js │ └── rb.js ├── parser.js ├── parsers │ ├── api.js │ ├── api_body.js │ ├── api_define.js │ ├── api_deprecated.js │ ├── api_description.js │ ├── api_error.js │ ├── api_error_example.js │ ├── api_example.js │ ├── api_group.js │ ├── api_header.js │ ├── api_header_example.js │ ├── api_name.js │ ├── api_param.js │ ├── api_param_example.js │ ├── api_permission.js │ ├── api_private.js │ ├── api_query.js │ ├── api_sample_request.js │ ├── api_success.js │ ├── api_success_example.js │ ├── api_use.js │ └── api_version.js ├── plugin_loader.js ├── utils │ ├── find_files.js │ └── unindent.js ├── worker.js └── workers │ ├── api_body_title.js │ ├── api_error_structure.js │ ├── api_error_title.js │ ├── api_group.js │ ├── api_header_structure.js │ ├── api_header_title.js │ ├── api_name.js │ ├── api_param_title.js │ ├── api_permission.js │ ├── api_query_title.js │ ├── api_sample_request.js │ ├── api_structure.js │ ├── api_success_structure.js │ ├── api_success_title.js │ └── api_use.js ├── package.json └── test ├── apidoc_test.js ├── parse_source_test.js ├── parser_api_body_test.js ├── parser_api_description_test.js ├── parser_api_param_test.js ├── parser_api_query_test.js ├── parsers └── api_param.js ├── util_unindent_test.js └── worker_api_use_test.js /.editorconfig: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/.editorconfig -------------------------------------------------------------------------------- /.github/workflows/validating.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/.github/workflows/validating.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | npm-debug.log 3 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/.npmignore -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/.npmrc -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/CHANGELOG.md -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/CONTRIBUTING.md -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/README.md -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/SECURITY.md -------------------------------------------------------------------------------- /hooks.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/hooks.md -------------------------------------------------------------------------------- /lib/errors/file_error.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/errors/file_error.js -------------------------------------------------------------------------------- /lib/errors/parameter_error.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/errors/parameter_error.js -------------------------------------------------------------------------------- /lib/errors/parser_error.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/errors/parser_error.js -------------------------------------------------------------------------------- /lib/errors/worker_error.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/errors/worker_error.js -------------------------------------------------------------------------------- /lib/filter.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/filter.js -------------------------------------------------------------------------------- /lib/filters/api_error.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/filters/api_error.js -------------------------------------------------------------------------------- /lib/filters/api_header.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/filters/api_header.js -------------------------------------------------------------------------------- /lib/filters/api_param.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/filters/api_param.js -------------------------------------------------------------------------------- /lib/filters/api_success.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/filters/api_success.js -------------------------------------------------------------------------------- /lib/index.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/index.js -------------------------------------------------------------------------------- /lib/languages/clj.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/clj.js -------------------------------------------------------------------------------- /lib/languages/coffee.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/coffee.js -------------------------------------------------------------------------------- /lib/languages/default.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/default.js -------------------------------------------------------------------------------- /lib/languages/erl.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/erl.js -------------------------------------------------------------------------------- /lib/languages/ex.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/ex.js -------------------------------------------------------------------------------- /lib/languages/lua.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/lua.js -------------------------------------------------------------------------------- /lib/languages/pm.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/pm.js -------------------------------------------------------------------------------- /lib/languages/py.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/py.js -------------------------------------------------------------------------------- /lib/languages/rb.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/languages/rb.js -------------------------------------------------------------------------------- /lib/parser.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parser.js -------------------------------------------------------------------------------- /lib/parsers/api.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api.js -------------------------------------------------------------------------------- /lib/parsers/api_body.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_body.js -------------------------------------------------------------------------------- /lib/parsers/api_define.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_define.js -------------------------------------------------------------------------------- /lib/parsers/api_deprecated.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_deprecated.js -------------------------------------------------------------------------------- /lib/parsers/api_description.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_description.js -------------------------------------------------------------------------------- /lib/parsers/api_error.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_error.js -------------------------------------------------------------------------------- /lib/parsers/api_error_example.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_error_example.js -------------------------------------------------------------------------------- /lib/parsers/api_example.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_example.js -------------------------------------------------------------------------------- /lib/parsers/api_group.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_group.js -------------------------------------------------------------------------------- /lib/parsers/api_header.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_header.js -------------------------------------------------------------------------------- /lib/parsers/api_header_example.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_header_example.js -------------------------------------------------------------------------------- /lib/parsers/api_name.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_name.js -------------------------------------------------------------------------------- /lib/parsers/api_param.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_param.js -------------------------------------------------------------------------------- /lib/parsers/api_param_example.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_param_example.js -------------------------------------------------------------------------------- /lib/parsers/api_permission.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_permission.js -------------------------------------------------------------------------------- /lib/parsers/api_private.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_private.js -------------------------------------------------------------------------------- /lib/parsers/api_query.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_query.js -------------------------------------------------------------------------------- /lib/parsers/api_sample_request.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_sample_request.js -------------------------------------------------------------------------------- /lib/parsers/api_success.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_success.js -------------------------------------------------------------------------------- /lib/parsers/api_success_example.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_success_example.js -------------------------------------------------------------------------------- /lib/parsers/api_use.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_use.js -------------------------------------------------------------------------------- /lib/parsers/api_version.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/parsers/api_version.js -------------------------------------------------------------------------------- /lib/plugin_loader.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/plugin_loader.js -------------------------------------------------------------------------------- /lib/utils/find_files.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/utils/find_files.js -------------------------------------------------------------------------------- /lib/utils/unindent.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/utils/unindent.js -------------------------------------------------------------------------------- /lib/worker.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/worker.js -------------------------------------------------------------------------------- /lib/workers/api_body_title.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_body_title.js -------------------------------------------------------------------------------- /lib/workers/api_error_structure.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_error_structure.js -------------------------------------------------------------------------------- /lib/workers/api_error_title.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_error_title.js -------------------------------------------------------------------------------- /lib/workers/api_group.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_group.js -------------------------------------------------------------------------------- /lib/workers/api_header_structure.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_header_structure.js -------------------------------------------------------------------------------- /lib/workers/api_header_title.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_header_title.js -------------------------------------------------------------------------------- /lib/workers/api_name.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_name.js -------------------------------------------------------------------------------- /lib/workers/api_param_title.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_param_title.js -------------------------------------------------------------------------------- /lib/workers/api_permission.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_permission.js -------------------------------------------------------------------------------- /lib/workers/api_query_title.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_query_title.js -------------------------------------------------------------------------------- /lib/workers/api_sample_request.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_sample_request.js -------------------------------------------------------------------------------- /lib/workers/api_structure.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_structure.js -------------------------------------------------------------------------------- /lib/workers/api_success_structure.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_success_structure.js -------------------------------------------------------------------------------- /lib/workers/api_success_title.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_success_title.js -------------------------------------------------------------------------------- /lib/workers/api_use.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/lib/workers/api_use.js -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/package.json -------------------------------------------------------------------------------- /test/apidoc_test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/apidoc_test.js -------------------------------------------------------------------------------- /test/parse_source_test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/parse_source_test.js -------------------------------------------------------------------------------- /test/parser_api_body_test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/parser_api_body_test.js -------------------------------------------------------------------------------- /test/parser_api_description_test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/parser_api_description_test.js -------------------------------------------------------------------------------- /test/parser_api_param_test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/parser_api_param_test.js -------------------------------------------------------------------------------- /test/parser_api_query_test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/parser_api_query_test.js -------------------------------------------------------------------------------- /test/parsers/api_param.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/parsers/api_param.js -------------------------------------------------------------------------------- /test/util_unindent_test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/util_unindent_test.js -------------------------------------------------------------------------------- /test/worker_api_use_test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apidoc/apidoc-core/HEAD/test/worker_api_use_test.js --------------------------------------------------------------------------------