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

[Twig] Add description to PhpTyes @var syntax #439

Closed
mekras opened this issue Feb 9, 2015 · 6 comments
Closed

[Twig] Add description to PhpTyes @var syntax #439

mekras opened this issue Feb 9, 2015 · 6 comments
Labels

Comments

@mekras
Copy link

mekras commented Feb 9, 2015

There is a great feature but it can be more useful with ability to describe variable like this:

{# @var foo \Foo\Bar description of this variable #}

Currently this is not supported. Without description:

Without description

With description:

With description

And will be very nice if the developer can write for template designer something like this:

{##
 # Some description of template, where and when it used
 #
 # @var foo \Some\Foo\Class description of variable "foo"
 # @var var \Some\Bar\Class description of variable "bar"
 #}
@Haehnchen
Copy link
Owner

thx, really good ideas.
whats about supporting some more doc tags which provides navigation like @see, @link?

Haehnchen added a commit that referenced this issue Feb 9, 2015
@mekras
Copy link
Author

mekras commented Feb 10, 2015

whats about supporting some more doc tags which provides navigation like @see, @link?

It will be useful, I think. But no nessesery for me :-)

@King2500
Copy link
Contributor

TwigDoc is born :)

@gharlan
Copy link

gharlan commented Mar 10, 2015

Imo the variable name and type should be swapped:

{# @var \Foo\Bar foo description of this variable #}

@Haehnchen
Copy link
Owner

done

@mekras
Copy link
Author

mekras commented Feb 12, 2016

Cool!

Haehnchen added a commit that referenced this issue Feb 14, 2016
…er names, twig files, classes and methods syntax #439
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants