Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support single line docs #42

Open
oojacoboo opened this issue May 20, 2017 · 10 comments
Open

Support single line docs #42

oojacoboo opened this issue May 20, 2017 · 10 comments

Comments

@oojacoboo
Copy link

Example:

/** @var \Foo $foo */
protected $foo
@neild3r
Copy link
Owner

neild3r commented May 23, 2017

How would you propose we differentiate the people that want this feature vs the people who don't?

@oojacoboo
Copy link
Author

oojacoboo commented May 24, 2017

Why would you not want that? I don't understand why anyone would type that and not want phpdoc "intellisense".

@neild3r
Copy link
Owner

neild3r commented May 24, 2017

Do you mean you want the tag snippets to work after a /**?

@oojacoboo
Copy link
Author

yes, that's correct.

@artrz
Copy link

artrz commented Nov 24, 2017

+1. Code intellisense extensions use this kind of docs to work. It would be so useful to have some sort of support for documenting vars.

@wunc
Copy link

wunc commented Mar 2, 2018

How would you propose we differentiate the people that want this feature vs the people who don't?

@neild3r, The way this works in the popular Sublime docblocker plugin is that if the user hits Enter after the /** they get the long-style doc block, but if they hit Spacebar or Shift+Enter they instead get the inline-style variable doc block.

See https://github.com/spadgos/sublime-jsdocs#variable-documentation

@oojacoboo
Copy link
Author

@wunc this is also how it works with IntelliJ.

@neild3r
Copy link
Owner

neild3r commented Mar 24, 2018

Annoyingly because the way this extension triggers the docblock using snippets I can't really do it like this. I think it will probably be easiest to just have a config option to turn it on.

@neild3r
Copy link
Owner

neild3r commented Mar 24, 2018

Also I will try to take a look at implementing this in the next few days or so

@neild3r
Copy link
Owner

neild3r commented Dec 24, 2018

Sorry I never progressed this one. I've had an extremely busy year and not had much time to put into this plugin. I'm going to spend a little time over the Christmas break trying to add some features and will include this as one of them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants