sublimetext/phpdoc

PhpDoc support package.

#PHPDoc

CodeDoc is a Sublime Text 2/3 plugin to speedup writing documenting comments.

Currently, PhpDoc for PHP is supported, therefore CodeDoc is renamed to PhpDoc until support of other documentation types is added (if ever).

To use, just type in /** on the line right before class or function declaration, and then invoke auto-completion (with e.g. ctrl+space). This will get you a template for starters, with some values pre-filled on the fly (such as function arguments list). All common documenting keys are also available for manual input.

On some systems you have to fiddle a bit to find the auto-completion key. If it's not working on your system, just type /** and choose Edit->Show Completions. In the menu, in front of the item it will be the key combination for the auto-completion (e.g. ctrl+space, alt+/, etc)

phpdoc's Issues

Viewing PHPDoc support for a function

Hi,

Thanks for taking the time to add PHPDoc support. I was wondering if there will be support in the future to view PHPDoc within the sublime-text itself. For instance, I have the following function:

/**

• Highlights the root of the menu when on a certain page
• @param string $page This is normally found in the page itself
• @param string $link This is defined in the menu
• @return string appends a class if the menu link and page match
  */
  function menu_selected($page, $link) {
  if($page == $link) {
  return 'class="menu-current"';
  } elseif($link == 'profile') {
  return 'class="menu-profile"';
  } else {
  return '';
  }
  }

If I press CTRL+Shift+Space (might conflict with other plugins, so this might have to be customizable), I will be able to see a dialog box or layer that shows the following information:

• Location of file referring to the function i.e system/inc/core.inc.php
• Name of function i.e. menu_selected
• Description of function i.e. "Highlights the root of the menu when on a certain page"
• A table of parameters with a heading called Parameters:
  string | $page | This is normally found in the page itself
  string | $link | This is defined in the menu
• "Return Value" heading which will display the type returned i.e. string, mixed, boolean etc and message "appends a class if the menu link and page match"

This is just and idea and I hope that this will become possible. I'll be glad to help test the feature out during development. :)

Use for other file types than PHP

I'd like to be able to use these shortcuts in CSS and JavaScript files too. How can I do this?

Auto complete won't work with '{}' as default parameter value

Hey there,

if I have such a function:

public function testFunction($val = '{}')
{
# code
}

Then the auto complete after the /** won't work anymore, while the default value for the parameter is {}.

@used-by and @api tags are not recognized.

The @Used-By and @api tags are not recognized by the plugin. And hence doesn't turn red.

And I am new to open source so if it's not too much trouble can I try to fix it? The fix seems simple enough. A new line needs to be added at line 32 in PhpDoc.sublime-completions. I am still getting the hang of all the pull request and merging. So I can try to do id. Thanks.

Can't make it work with ST3

Nothing happens when trying to expand /**.

Any shortcut to exit from comment mode?

As per above?

Support Zephir syntax

I've tried to add Zephir syntax in CodeDoc.py, but it still not work.
Please, add phpdoc highlighting for phpdoc with zephir syntax.

Zephir files is very similar to php, file for example: https://github.com/wapmorgan/Shell/blob/master/shell/Shell.zep

Comment block not valid

Hi. My SublimeLinter phpcs say: "There must be exactly one blank line before the tags in a doc comment".

Have:

/**
 * Permissions for Editor users.
 * @return array
 *   of all permisssions for Editor user role
 */

Need:

/**
 * Permissions for Editor users.
 *
 * @return array
 *   of all permisssions for Editor user role
 */

Sublime text 3 compatibility

Is there any plan to make this plugins compatible with Sublime Text 3?

Custom @

Hi there, thanks for this plugin!!!

I'm wondering if i could put some custom '@' at the default /**

for example, when i type /** the plugin puts the @params and @returns but it would nice to have the @SInCE at the end of docblock....

How can i do that ?

Thanks in advance!

Request: support typing of params

In a function declaration, later versions of PHP support typing of input parameters. PhpDoc should support this and use the class type as the type input in the default block.

Example of current behavior:

Example of expected output:

Error on OSX

/** + crlt + space

This close sublime =/