nikhilkalige / docblockr Goto Github PK
View Code? Open in Web Editor NEWDocBlockr is a package for Atom which is designed to make writing documentation faster and easier.
License: MIT License
DocBlockr is a package for Atom which is designed to make writing documentation faster and easier.
License: MIT License
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (/Applications/Atom.app/Contents/Resources/app/src/atom.js:55:11)
new DocBlockrAtom (/Users/tomaszahradnik/.atom/packages/docblockr/lib/docblockr-worker.js:148:11)
Uncaught TypeError: Cannot read property '1' of null
/Users/ilanb/.atom/packages/docblockr/lib/docblockr-worker.js:561
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (C:\Users\Djmemo\AppData\Local\atom\app-0.178.0\resources\app\src\atom.js:54:11)
new DocBlockrAtom (C:\Users\Djmemo\.atom\packages\docblockr\lib\docblockr-worker.js:148:11)
I'm on Atom v0.181.0 and I just updated docblockr to 0.6.2 and now nothing works. Tried restarting Atom, my computer--and even uninstalling and reinstalling the package.
0.6.3 has stuff working; however, functionality isn't the same as it was pre-0.6.2. See my comments below. Anything from javadoc'ing to just commenting seems to add an unnecessary newline.
Running on linux
Atom Version: 0.165.0
System: linux 3.13.0-24-generic
Thrown From: docblockr package, v0.5.8
Uncaught TypeError: undefined is not a function
At /home/nathan/.atom/packages/docblockr/lib/docsparser.js:50
TypeError: undefined is not a function
at DocsParser.parse (/home/nathan/.atom/packages/docblockr/lib/docsparser.js:50:16)
at DocBlockrAtom.module.exports.DocBlockrAtom.parse_command (/home/nathan/.atom/packages/docblockr/lib/docblockr-worker.js:268:29)
at atom-workspace.<anonymous> (/home/nathan/.atom/packages/docblockr/lib/docblockr-worker.js:64:16)
at atom-workspace.handler (/opt/atom/resources/app/src/space-pen-extensions.js:115:32)
at atom-workspace.jQuery.event.dispatch (/opt/atom/resources/app/node_modules/space-pen/vendor/jquery.js:4681:9)
at atom-workspace.elemData.handle (/opt/atom/resources/app/node_modules/space-pen/vendor/jquery.js:4359:46)
at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (/opt/atom/resources/app/src/command-registry.js:243:29)
at /opt/atom/resources/app/src/command-registry.js:3:61
at KeymapManager.module.exports.KeymapManager.dispatchCommandEvent (/opt/atom/resources/app/node_modules/atom-keymap/lib/keymap-manager.js:549:16)
at KeymapManager.module.exports.KeymapManager.handleKeyboardEvent (/opt/atom/resources/app/node_modules/atom-keymap/lib/keymap-manager.js:391:22)
at HTMLDocument.module.exports.WindowEventHandler.onKeydown (/opt/atom/resources/app/src/window-event-handler.js:167:20)
-0:39.1 snippets:expand (input.hidden-input)
-0:39.1 docblockr:parse-tab (input.hidden-input)
-0:39.1 editor:indent (input.hidden-input)
-0:38.6 core:backspace (input.hidden-input)
-0:36.3 core:move-down (input.hidden-input)
-0:35.9 docblockr:parse-enter (input.hidden-input)
-0:26.8 editor:move-to-end-of-screen-line (input.hidden-input)
3x -0:17.7 core:backspace (input.hidden-input)
4x -0:14.4 core:select-up (input.hidden-input)
-0:12.9 core:select-down (input.hidden-input)
-0:11.0 editor:select-to-first-character-of-line (input.hidden-input)
-0:09.9 core:delete (input.hidden-input)
-0:06.5 docblockr:parse-enter (input.hidden-input)
-0:03.4 editor:move-to-end-of-screen-line (input.hidden-input)
-0:00.7 core:move-down (input.hidden-input)
2x -0:00.0 docblockr:parse-enter (input.hidden-input)
{
"core": {
"themes": [
"atom-dark-ui",
"flatland-dark"
]
}
}
# User
docblockr, v0.5.8
flatland-dark, v0.1.3
language-glsl, v0.2.2
language-rust, v0.3.2
language-unity-shaderlab, v1.0.1
# Dev
No dev packages
/cc @atom/core
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (/Applications/Atom.app/Contents/Resources/app/src/atom.js:55:11)
new DocBlockrAtom (/Users/tomaszahradnik/.atom/packages/docblockr/lib/docblockr-worker.js:19:11)
The sublime package uses group names in regex for reference. In JS i don’t think this ability is present. So i have removed the back reference group names, as result there is mismatch.
So the solution would be to move away from the parent sublime package, or write some function so that python like back reference can be used directly
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (/usr/share/atom/resources/app/src/atom.js:53:11)
new DocBlockrAtom (/home/amorales/.atom/packages/docblockr/lib/docblockr-worker.js:43:11)
Steps to repro:
mv ~/.atom ~/.atom.backup
apm install docblockr
atom .
After that, I see this:
Error: Cannot find module '../lib/docblockr-view'
at Function.Module._resolveFilename (module.js:337:15)
at Function.Module._load (module.js:279:25)
at Module.require (module.js:363:17)
at require (module.js:379:17)
at Object.<anonymous> (/Users/dmnd/.atom/packages/docblockr/spec/docblockr-view-spec.coffee:1:17)
at Object.<anonymous> (/Users/dmnd/.atom/packages/docblockr/spec/docblockr-view-spec.coffee:1:1)
at Module._compile (module.js:455:26)
at Object.requireCoffeeScript [as .coffee] (/Users/dmnd/github/atom/src/coffee-cache.coffee:39:10)
at Module.load (/Users/dmnd/github/atom/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:311:12)
at Module.require (module.js:363:17)
at require (module.js:379:17)
at requireSpecs (/Users/dmnd/github/atom/spec/spec-suite.coffee:8:5)
at runAllSpecs (/Users/dmnd/github/atom/spec/spec-suite.coffee:48:3)
at Object.<anonymous> (/Users/dmnd/github/atom/spec/spec-suite.coffee:55:3)
at Object.<anonymous> (/Users/dmnd/github/atom/spec/spec-suite.coffee:1:1)
at Module._compile (module.js:455:26)
at Object.requireCoffeeScript [as .coffee] (/Users/dmnd/github/atom/src/coffee-cache.coffee:39:10)
at Module.load (/Users/dmnd/github/atom/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:311:12)
at Module.require (module.js:363:17)
at require (module.js:379:17)
at module.exports.runSpecSuite (/Users/dmnd/github/atom/spec/jasmine-helper.coffee:31:3)
at Object.<anonymous> (/Users/dmnd/github/atom/spec/spec-bootstrap.coffee:24:3)
at Object.<anonymous> (/Users/dmnd/github/atom/spec/spec-bootstrap.coffee:2:1)
at Module._compile (module.js:455:26)
at Object.requireCoffeeScript [as .coffee] (/Users/dmnd/github/atom/src/coffee-cache.coffee:39:10)
at Module.load (/Users/dmnd/github/atom/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:311:12)
at Module.require (module.js:363:17)
at require (module.js:379:17)
at window.onload (file:///Users/dmnd/github/atom/static/index.js:20:25)
Getting 2 show-stopping errors while trying to use docblockr (v0.5.8
) with the latest version (v0.136.0
) of atom.
When I enter /**<Enter>
it just dies compeletely with these errors:
Error: Module version mismatch. Expected 15, got 14.
at Error (native)
at Object.module.(anonymous function) [as .node] (/Applications/Atom.app/Contents/Resources/atom/common/lib/asar.js:416:20)
at Module.load (/Applications/Atom.app/Contents/Resources/app/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:318:12)
at Module.require (module.js:373:17)
at require (module.js:392:17)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/node_modules/oniguruma/lib/oniguruma.js:4:17)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/node_modules/oniguruma/lib/oniguruma.js:42:4)
at Module._compile (module.js:468:26)
at Object.Module._extensions..js (module.js:486:10)
at Module.load (/Applications/Atom.app/Contents/Resources/app/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:318:12)
at Module.require (module.js:373:17)
at require (module.js:392:17)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight-model.coffee:3:16)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight-model.coffee:1:1)
at Module._compile (module.js:468:26)
at Object.requireCoffeeScript [as .coffee] (/Applications/Atom.app/Contents/Resources/app/src/coffee-cache.js:61:19)
at Module.load (/Applications/Atom.app/Contents/Resources/app/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:318:12)
at Module.require (module.js:373:17)
at require (module.js:392:17)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight-editor.coffee:4:27)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight-editor.coffee:1:1)
at Module._compile (module.js:468:26)
at Object.requireCoffeeScript [as .coffee] (/Applications/Atom.app/Contents/Resources/app/src/coffee-cache.js:61:19)
at Module.load (/Applications/Atom.app/Contents/Resources/app/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:318:12)
at Module.require (module.js:373:17)
at require (module.js:392:17)
at /Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight.coffee:18:36
at atom-workspace.attachedCallback (/Applications/Atom.app/Contents/Resources/app/src/workspace-view.js:94:18)
at atom-workspace.jQuery.event.dispatch (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4676:9)
at atom-workspace.elemData.handle (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4360:46)
at Object.jQuery.event.trigger (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4594:12)
at HTMLDivElement.<anonymous> (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:5119:17)
at Function.jQuery.extend.each (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:590:23)
at TextEditorView.jQuery.fn.jQuery.each (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:237:17)
at TextEditorView.jQuery.fn.extend.trigger (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:5118:15)
at TextEditorView.module.exports.TextEditorView.afterAttach (/Applications/Atom.app/Contents/Resources/app/src/text-editor-view.js:171:19)
at callAttachHooks (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/lib/space-pen.js:343:67)
at [object Object].jQuery.fn.(anonymous function) [as append] (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/lib/space-pen.js:396:9)
at atom-pane.PaneElement.activeItemChanged (/Applications/Atom.app/Contents/Resources/app/src/pane-element.js:191:20)
at Emitter.module.exports.Emitter.emit (/Applications/Atom.app/Contents/Resources/app/node_modules/event-kit/lib/emitter.js:71:11)
at Pane.module.exports.Pane.setActiveItem (/Applications/Atom.app/Contents/Resources/app/src/pane.js:254:22)
at Pane.module.exports.Pane.addItem (/Applications/Atom.app/Contents/Resources/app/src/pane.js:325:14)
at Pane.module.exports.Pane.activateItem (/Applications/Atom.app/Contents/Resources/app/src/pane.js:299:14)
at /Applications/Atom.app/Contents/Resources/app/src/workspace.js:446:16
at _fulfilled (/Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:787:54)
at self.promiseDispatch.done (/Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:816:30)
at Promise.promise.promiseDispatch (/Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:749:13)
at /Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:557:44
at flush (/Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:108:17)
at process._tickCallback (node.js:378:11)
Error: Module did not self-register.
at Error (native)
at Object.module.(anonymous function) [as .node] (/Applications/Atom.app/Contents/Resources/atom/common/lib/asar.js:416:20)
at Module.load (/Applications/Atom.app/Contents/Resources/app/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:318:12)
at Module.require (module.js:373:17)
at require (module.js:392:17)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/node_modules/oniguruma/lib/oniguruma.js:4:17)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/node_modules/oniguruma/lib/oniguruma.js:42:4)
at Module._compile (module.js:468:26)
at Object.Module._extensions..js (module.js:486:10)
at Module.load (/Applications/Atom.app/Contents/Resources/app/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:318:12)
at Module.require (module.js:373:17)
at require (module.js:392:17)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight-model.coffee:3:16)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight-model.coffee:1:1)
at Module._compile (module.js:468:26)
at Object.requireCoffeeScript [as .coffee] (/Applications/Atom.app/Contents/Resources/app/src/coffee-cache.js:61:19)
at Module.load (/Applications/Atom.app/Contents/Resources/app/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:318:12)
at Module.require (module.js:373:17)
at require (module.js:392:17)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight-editor.coffee:4:27)
at Object.<anonymous> (/Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight-editor.coffee:1:1)
at Module._compile (module.js:468:26)
at Object.requireCoffeeScript [as .coffee] (/Applications/Atom.app/Contents/Resources/app/src/coffee-cache.js:61:19)
at Module.load (/Applications/Atom.app/Contents/Resources/app/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
at Function.Module._load (module.js:318:12)
at Module.require (module.js:373:17)
at require (module.js:392:17)
at /Users/dominic/.atom/packages/atom-color-highlight/lib/atom-color-highlight.coffee:18:36
at atom-workspace.attachedCallback (/Applications/Atom.app/Contents/Resources/app/src/workspace-view.js:94:18)
at atom-workspace.jQuery.event.dispatch (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4676:9)
at atom-workspace.elemData.handle (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4360:46)
at Object.jQuery.event.trigger (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4594:12)
at HTMLDivElement.<anonymous> (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:5119:17)
at Function.jQuery.extend.each (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:590:23)
at TextEditorView.jQuery.fn.jQuery.each (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:237:17)
at TextEditorView.jQuery.fn.extend.trigger (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:5118:15)
at TextEditorView.module.exports.TextEditorView.afterAttach (/Applications/Atom.app/Contents/Resources/app/src/text-editor-view.js:171:19)
at callAttachHooks (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/lib/space-pen.js:343:67)
at [object Object].jQuery.fn.(anonymous function) [as append] (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/lib/space-pen.js:396:9)
at atom-pane.PaneElement.activeItemChanged (/Applications/Atom.app/Contents/Resources/app/src/pane-element.js:191:20)
at Emitter.module.exports.Emitter.emit (/Applications/Atom.app/Contents/Resources/app/node_modules/event-kit/lib/emitter.js:71:11)
at Pane.module.exports.Pane.setActiveItem (/Applications/Atom.app/Contents/Resources/app/src/pane.js:254:22)
at Pane.module.exports.Pane.activateItem (/Applications/Atom.app/Contents/Resources/app/src/pane.js:300:21)
at /Applications/Atom.app/Contents/Resources/app/src/workspace.js:446:16
at _fulfilled (/Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:787:54)
at self.promiseDispatch.done (/Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:816:30)
at Promise.promise.promiseDispatch (/Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:749:13)
at /Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:557:44
at flush (/Applications/Atom.app/Contents/Resources/app/node_modules/q/q.js:108:17)
at process._tickCallback (node.js:378:11)
Can you please release 0.5.8 on atom.io? Currently it is 0.5.2
would it be possible to add support for generator javascript functions?
function* (param)
I find this package extremely helpful, working in koajs many functions are defined like this and no parameters are added to the comment.
The package doesn't seem to correctly output the parameter types in PHP. If you pre supply them, it leaves the [type] placeholder, and in every instance it wraps types in {}, which I'm not sure is convention. The same plugin for Sublime Text behaves correctly.
You can see above how it leaves in the [type] placeholder, and wraps the types in {}.
Thanks in advance.
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (C:\Users\Djmemo\AppData\Local\atom\app-0.178.0\resources\app\src\atom.js:54:11)
new DocBlockrAtom (C:\Users\Djmemo\.atom\packages\docblockr\lib\docblockr-worker.js:124:11)
I just installed DocBlockr. When I hit /**
+ Enter
/Tab
, the console opens up with the following error.
Uncaught TypeError: Cannot read property 'mainModule' of undefined /Users/curtisblackwell/.atom/packages/docblockr/lib/docblockr-worker.js:719
module.exports.DocBlockrAtom.write /Users/curtisblackwell/.atom/packages/docblockr/lib/docblockr-worker.js:719
module.exports.DocBlockrAtom.parse_command /Users/curtisblackwell/.atom/packages/docblockr/lib/docblockr-worker.js:273
(anonymous function) /Users/curtisblackwell/.atom/packages/docblockr/lib/docblockr-worker.js:64
jQuery.event.dispatch /Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4676
elemData.handle /Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4360
module.exports.KeymapManager.dispatchCommandEvent /Applications/Atom.app/Contents/Resources/app/node_modules/atom-keymap/lib/keymap-manager.js:395
module.exports.KeymapManager.handleKeyboardEvent /Applications/Atom.app/Contents/Resources/app/node_modules/atom-keymap/lib/keymap-manager.js:176
(anonymous function) /Applications/Atom.app/Contents/Resources/app/src/window-event-handler.js:90
jQuery.event.dispatch /Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4676
elemData.handle /Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4360
Do you think there's a conflict with another plugin, or do you have any other idea what might be going wrong?
Thanks!
P.S.
Running Atom 0.103.0 on Mac OS X 10.9.3
I'd really like to customise the default output.
Something like how the extra tags is defined, but including the default tags like description (or perhaps just an on/off switch for the parameters).
And with a reset button to get back the defaults.
I've already pulled the repo and am looking into it, but I've got no experience in JS or CS, only in C++ and a little PHP.
I'am using atom on windows plataform, and after install the plugin, the char "/" not works.
:/
Attempting to add a Javadoc comment to the wrap method below causes docblockr to throw, ReferenceError: False is not defined.
class Class {
/**[press Enter]
private String wrap(String content) {
return "(" + content + ")";
}
}
The issue originates from:
JavaParser.prototype.setup_settings = function () {
var identifier = '[a-zA-Z_$][a-zA-Z_$0-9]*';
this.settings = {
'curlyTypes': False,
^~~ here
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (/Applications/Atom.app/Contents/Resources/app/src/atom.js:55:11)
new DocBlockrAtom (/Users/Eytan/.atom/packages/docblockr/lib/docblockr-worker.js:19:11)
Noticed this starting in 0.5.8 (atom 0.165.0) the "auto_add_method_tag" setting does not seem to read my user config value of true. I have temporarily fixed this locally by changing the default value to true in the plugin.
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (/usr/share/atom/resources/app/src/atom.js:53:11)
new DocBlockrAtom (/home/amorales/.atom/packages/docblockr/lib/docblockr-worker.js:19:11)
Hey Nikhil,
I just came across this plugin today when I was trying out Atom Editor for the first time. While I'm pleased that you enjoy my work on the original Sublime Text version of it, it's not so pleasing to see my work copied and distributed under your name.
The license on the original work is very permissive, but merely asks that you give credit where due (I have seen the link at the bottom of the readme). Copying that license and changing my name to yours is not such a nice thing to do. Would you consider either a) adding my name back into the license, or b) replace the copied text and graphics with your own original work and rename the plugin to avoid confusion.
Thank you,
Nick
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (C:\Users\Djmemo\AppData\Local\atom\app-0.178.0\resources\app\src\atom.js:54:11)
new DocBlockrAtom (C:\Users\Djmemo\.atom\packages\docblockr\lib\docblockr-worker.js:43:11)
Multiine decorate feature is not working as intended.
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (/usr/share/atom/resources/app/src/atom.js:53:11)
new DocBlockrAtom (/home/amorales/.atom/packages/docblockr/lib/docblockr-worker.js:111:11)
Dockblokr will ignore the Extend double slash option on Ubuntu 14.04 on PHP docs. It will extend // comments to the next line even with this option disabled.
Probably related to #2 .
[Enter steps to reproduce below:]
Atom Version: 0.179.0
System: Mac OS X 10.10.2
Thrown From: docblockr package, v0.5.8
Uncaught TypeError: Cannot read property '1' of null
At /Users/cameres/.atom/packages/docblockr/lib/docsparser.js:538
TypeError: Cannot read property '1' of null
at DocsParser.CppParser.get_arg_name (/Users/cameres/.atom/packages/docblockr/lib/docsparser.js:538:19)
at DocsParser.parse_args (/Users/cameres/.atom/packages/docblockr/lib/docsparser.js:269:48)
at DocsParser.CppParser.parse_args (/Users/cameres/.atom/packages/docblockr/lib/docsparser.js:527:44)
at DocsParser.format_function (/Users/cameres/.atom/packages/docblockr/lib/docsparser.js:134:32)
at DocsParser.parse (/Users/cameres/.atom/packages/docblockr/lib/docsparser.js:48:37)
at DocBlockrAtom.module.exports.DocBlockrAtom.parse_command (/Users/cameres/.atom/packages/docblockr/lib/docblockr-worker.js:268:29)
at atom-workspace.<anonymous> (/Users/cameres/.atom/packages/docblockr/lib/docblockr-worker.js:64:16)
at atom-workspace.handler (/Applications/Atom.app/Contents/Resources/app/src/space-pen-extensions.js:115:32)
at atom-workspace.jQuery.event.dispatch (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4681:9)
at atom-workspace.elemData.handle (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4359:46)
at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (/Applications/Atom.app/Contents/Resources/app/src/command-registry.js:243:29)
at /Applications/Atom.app/Contents/Resources/app/src/command-registry.js:3:61
at KeymapManager.module.exports.KeymapManager.dispatchCommandEvent (/Applications/Atom.app/Contents/Resources/app/node_modules/atom-keymap/lib/keymap-manager.js:558:16)
at KeymapManager.module.exports.KeymapManager.handleKeyboardEvent (/Applications/Atom.app/Contents/Resources/app/node_modules/atom-keymap/lib/keymap-manager.js:396:22)
at HTMLDocument.module.exports.WindowEventHandler.onKeydown (/Applications/Atom.app/Contents/Resources/app/src/window-event-handler.js:172:20)
-1:52.6 snippets:expand (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
-1:52.6 editor:indent (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
5x -1:51.6 core:backspace (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
-1:48.1 docblockr:parse-enter (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
15x -1:46.4 core:backspace (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
-1:35.0 core:save (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
2x -0:37.5 docblockr:parse-enter (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
5x -0:30.2 core:backspace (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
3x -0:28.0 docblockr:parse-enter (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
3x -0:18.4 core:backspace (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
-0:17.2 core:move-down (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
3x -0:16.7 core:move-right (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
3x -0:15.9 core:backspace (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
-0:13.6 docblockr:parse-enter (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
-0:08.5 core:backspace (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
3x -0:07.6 docblockr:parse-enter (atom-text-editor.editor.vim-mode.autocomplete-active.insert-mode.is-focused)
{
"core": {
"themes": [
"one-dark-ui",
"one-dark-syntax"
]
},
"docblockr": {}
}
# User
autocomplete-plus, v2.1.3
docblockr, v0.5.8
file-icons, v1.4.9
jshint, v1.2.0
minimap, v4.1.4
tabs-to-spaces, v0.8.1
vim-mode, v0.31.0
# Dev
No dev packages
Wrap Lines feature opens debug console.
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (C:\Users\Djmemo\AppData\Local\atom\app-0.178.0\resources\app\src\atom.js:54:11)
new DocBlockrAtom (C:\Users\Djmemo\.atom\packages\docblockr\lib\docblockr-worker.js:111:11)
This error happens when I have text selected in one pane, use a compiler or generator that creates its output in a new pane, then press enter or tab in the new pane.
TypeError: Cannot read property 'getCursors' of undefined
at DocBlockrAtom.module.exports.DocBlockrAtom.validate_request (c:\Users\James\.atom\packages\docblockr\lib\docblockr-worker.js:189:36)
at atom-workspace.<anonymous> (c:\Users\James\.atom\packages\docblockr\lib\docblockr-worker.js:62:17)
at atom-workspace.handler (c:\Users\James\AppData\Local\atom\app-0.169.0\resources\app\src\space-pen-extensions.js:115:32)
at atom-workspace.jQuery.event.dispatch (c:\Users\James\AppData\Local\atom\app-0.169.0\resources\app\node_modules\space-pen\vendor\jquery.js:4681:9)
at atom-workspace.elemData.handle (c:\Users\James\AppData\Local\atom\app-0.169.0\resources\app\node_modules\space-pen\vendor\jquery.js:4359:46)
at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (c:\Users\James\AppData\Local\atom\app-0.169.0\resources\app\src\command-registry.js:243:29)
at c:\Users\James\AppData\Local\atom\app-0.169.0\resources\app\src\command-registry.js:3:61
at KeymapManager.module.exports.KeymapManager.dispatchCommandEvent (c:\Users\James\AppData\Local\atom\app-0.169.0\resources\app\node_modules\atom-keymap\lib\keymap-manager.js:549:16)
at KeymapManager.module.exports.KeymapManager.handleKeyboardEvent (c:\Users\James\AppData\Local\atom\app-0.169.0\resources\app\node_modules\atom-keymap\lib\keymap-manager.js:391:22)
at HTMLDocument.module.exports.WindowEventHandler.onKeydown (c:\Users\James\AppData\Local\atom\app-0.169.0\resources\app\src\window-event-handler.js:167:20)
Auto adding doc block for JS doesn't seem to add a return value line
it'd be nice to be able to support extending the docblock when you press return.
If you use a Markdown header using the # Header
format, pressing enter will add a new header line below this. One possible solution is to test the current scope to see if it's a comment:
var scope = editor.getCursorScopes();
if (/^comment/.test(scope[1])) {
// ...
}
Thanks for adding this for Atom. If I end up switching I definitely need it!
Hey there,
Quick question: how should we fill the extra tags in settings field? I have no luck setting them yet. Is it array, comma separated, something else?
Regarding changelog - recent changes are pointed to August, while we are July yet. :)
P.S. Something else I just came to - Atom does not pick docblockr for update, when there is new version here. I was stuck to 0.5.2 for a while, until I saw 0.5.6 here. Same issue with 0.5.7 - it doesn't load as "update", but if I reinstall it, the recent version will be applied.
Thanks!
When js function name starts with a upper case letter (is a class class constructor), annotation @constructor should be inserted. This can be optional.
/**
* @constructor
*/
function Dog() {
// ...
}
I am getting this error when I try to docblock a class property in javascript:
Uncaught TypeError: Cannot read property 'replace' of undefined c:\Users\****\.atom\packages\docblockr\lib\docsparser.js:7
Example of what I try to docblock (I trigger this with /**
):
this.options = {
swfPath: '',
supplied: 'mp3',
wmode: "window",
};
I am working with Atom on a Windows 7 maschine.
There is an "Auto add method tag" option that doesn't appear to be working.
I found "auto_add_method_tag" in the code but it doesn't appear to be referenced anywhere.
While trying to use /**
comments preceding a variable being assigned a newly bound function I get the following error:
Uncaught TypeError: Cannot call method 'replace' of undefined
So, something like the following fails:
fooBar = foo.bind(null, "bar")
Seems to be an error in the parser when handling assignments. The following examples fail similarly:
this.x = 1
FooClass.prototype.y = 123
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (C:\Users\Djmemo\AppData\Local\atom\app-0.178.0\resources\app\src\atom.js:54:11)
new DocBlockrAtom (C:\Users\Djmemo\.atom\packages\docblockr\lib\docblockr-worker.js:136:11)
Not sure if that's the best "Title" for this bug.
The issue seems to be thus:
I have a Doc Block like this:
/**
* This service will deal with submission
**/
services.factory("submissionService", ['$http', function($http) {
// Note: this will change when we send this into the form
var submitUrl = "http://some.url";
Two things happen.. if I go up tot he function declaration, and press enter to have some white space after the {
I get a single * after the { so it looks like: { *
The same thing happens of I go to the end of the "var" line and press enter.. at the end of the line it adds: // so it looks like:
var submitUrl = "http://some.url";//
Now the second is of less consequence than the first.. but thought you would like to know
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (C:\Users\Djmemo\AppData\Local\atom\app-0.178.0\resources\app\src\atom.js:54:11)
new DocBlockrAtom (C:\Users\Djmemo\.atom\packages\docblockr\lib\docblockr-worker.js:130:11)
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (C:\Users\Djmemo\AppData\Local\atom\app-0.178.0\resources\app\src\atom.js:54:11)
new DocBlockrAtom (C:\Users\Djmemo\.atom\packages\docblockr\lib\docblockr-worker.js:19:11)
Create a new documentation block just above an Annotation in java
Ex.
/**<cr>
@Override
public boolean isEmpty() {
// snip
}
**Atom Version**: 0.177.0
**System**: Mac OS X 10.10
**Thrown From**: [docblockr](https://github.com/nikhilkalige/docblockr) package, v0.5.8
### Stack Trace
Uncaught SyntaxError: Invalid regular expression: /(/: Unterminated group
At /Users/samdoiron/.dotfiles/atom.symlink/packages/docblockr/lib/docsparser.js:1111
SyntaxError: Invalid regular expression: /(/: Unterminated group
at new RegExp (native)
at RegExp (native)
at String.search (native)
at DocsParser.JavaParser.get_definition (/Users/samdoiron/.dotfiles/atom.symlink/packages/docblockr/lib/docsparser.js:1111:26)
at DocBlockrAtom.module.exports.DocBlockrAtom.initialize (/Users/samdoiron/.dotfiles/atom.symlink/packages/docblockr/lib/docblockr-worker.js:704:26)
at DocBlockrAtom.module.exports.DocBlockrAtom.parse_command (/Users/samdoiron/.dotfiles/atom.symlink/packages/docblockr/lib/docblockr-worker.js:258:12)
at atom-workspace. (/Users/samdoiron/.dotfiles/atom.symlink/packages/docblockr/lib/docblockr-worker.js:64:16)
at atom-workspace.handler (/Applications/Atom.app/Contents/Resources/app/src/space-pen-extensions.js:115:32)
at atom-workspace.jQuery.event.dispatch (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4681:9)
at atom-workspace.elemData.handle (/Applications/Atom.app/Contents/Resources/app/node_modules/space-pen/vendor/jquery.js:4359:46)
at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (/Applications/Atom.app/Contents/Resources/app/src/command-registry.js:243:29)
at /Applications/Atom.app/Contents/Resources/app/src/command-registry.js:3:61
at KeymapManager.module.exports.KeymapManager.dispatchCommandEvent (/Applications/Atom.app/Contents/Resources/app/node_modules/atom-keymap/lib/keymap-manager.js:558:16)
at KeymapManager.module.exports.KeymapManager.handleKeyboardEvent (/Applications/Atom.app/Contents/Resources/app/node_modules/atom-keymap/lib/keymap-manager.js:396:22)
at HTMLDocument.module.exports.WindowEventHandler.onKeydown (/Applications/Atom.app/Contents/Resources/app/src/window-event-handler.js:170:20)
### Commands
-0:10.4 core:save (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:10.3 vim-mode:move-up (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
7x -0:10.2 vim-mode:move-down (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:09.1 vim-mode:move-up (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
3x -0:08.7 vim-mode:move-down (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
4x -0:07.8 vim-mode:move-up (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
3x -0:07.1 vim-mode:move-down (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
7x -0:06.3 vim-mode:move-up (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
10x -0:04.0 vim-mode:move-down (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:02.9 vim-mode:move-up (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:02.8 vim-mode:insert-below-with-newline (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:02.2 docblockr:parse-tab (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:02.2 snippets:next-tab-stop (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:02.2 snippets:expand (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:02.2 editor:indent (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
-0:00.7 docblockr:parse-enter (atom-text-editor.editor.vim-mode.autocomplete-active.is-focused.insert-mode)
### Config
```json
{
"core": {
"ignoredNames": [
".bundle",
".git",
"log",
"repositories",
"tmp",
"vendor"
],
"disabledPackages": [
"background-tips",
"exception-reporting",
"metrics",
"linter-javac"
],
"themes": [
"isotope-ui",
"solarized-dark-syntax"
]
}
}
# User
atom-color-highlight, v3.0.6
autocomplete-plus, v2.1.3
docblockr, v0.5.8
isotope-ui, v1.2.10
linter, v0.11.1
linter-clang, v2.25.1
minimap, v4.1.2
vim-mode, v0.30.0
# Dev
No dev packages
/cc @atom/core
atom.workspaceView is no longer available.
In most cases you will not need the view. See the Workspace docs for
alternatives: https://atom.io/docs/api/latest/Workspace.
If you do need the view, please use atom.views.getView(atom.workspace)
,
which returns an HTMLElement.
Atom.Object.defineProperty.get (C:\Users\Djmemo\AppData\Local\atom\app-0.178.0\resources\app\src\atom.js:54:11)
new DocBlockrAtom (C:\Users\Djmemo\.atom\packages\docblockr\lib\docblockr-worker.js:142:11)
Error because lib/docsparser.js has false as False at line 996, 997, 821 and 822 .
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.