GithubHelp home page GithubHelp logo

wikunia / brackets-quickdocsphp Goto Github PK

View Code? Open in Web Editor NEW
55.0 55.0 18.0 4.5 MB

Inline short documentation for PHP functions, including a summary and parameters.

JavaScript 79.95% CSS 15.52% HTML 4.53%

brackets-quickdocsphp's People

Contributors

vjandrea avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

brackets-quickdocsphp's Issues

Function definition in the description

Thanks for this awesome extension, I love it, but one think I am missing from the PHP.net docs is the function definition that they add to the description, like they do here: http://ar2.php.net/manual/en/function.mktime.php.

What I would like to see in the codes is something like this for the mktime function (as an example):

int mktime ([ int $hour = date("H") [, int $minute = date("i") 
    [, int $second = date("s") [, int $month = date("n") [, int $day = date("j")
    [, int $year = date("Y") [, int $is_dst = -1 ]]]]]]] )

Which sometimes makes the parameters a lot easier to read.

Editor loses focus on Ctrl+k

Currently when you press Ctrl+K the main editor loses focus so you can't continue to write without clicking in the editor or pressing esc. Would be nice if the editor kept the focus.

Add method return values in Docs

Hi,

Great plugin! Just what Brackets needed for PHP. The only thing I wish it included was the return values of the methods.

For example, if strstr returns a String if successful or False if not.. .etc.

Otherwise, great work.

Best,
Aaron

Newlines between parameters breaks JavaDoc parsing

<?php

/**
 * @param $a Foo
 */
function foo(
    $a
){
    return true;
}

$abc = foo(true);

Pressing Ctrl + K in foo(true) responds with "No Quick Docs available for current cursor position" instead of documentation.

shortcut

Hi,

when I'm using ctrl+K just the linebreak is deleted. Is it possible to change the keys?

Regards
André

Support phpDocs instead of (or in addition to) JavaDocs

phpDocs are more common in the PHP world (at least in my experience), and allow for more details, such as parameter type in @param.

For example, assuming the following:

<?php

/**
 * @param array $a Foo
 */
function foo(array $a){
    return true;
}

$abc = foo(true);

The documentation shows array as the variable name, and $a Foo as the description for the variable. It would be nice if this showed $a as the variable, array as the type, and Foo as the description.

Don't work on Ubuntu

Hello!

The plugin is great! But it doesn't work on Ubuntu, this would work in another distro? My distro is Ubuntu 12.04 and the version of Brackets is 0.41.

Thanks and good work!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.