https://github.com/wikunia/brackets-quickdocsphp

Inline short documentation for PHP functions, including a summary and parameters.
https://github.com/wikunia/brackets-quickdocsphp

Last synced: 12 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/wikunia/brackets-quickdocsphp
• Owner: Wikunia
• Created: 2014-03-04T12:30:39.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-03-18T14:54:21.000Z (almost 3 years ago)
• Last Synced: 2025-02-27T15:46:32.298Z (about 1 year ago)
• Language: JavaScript
• Size: 4.39 MB
• Stars: 55
• Watchers: 9
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

          
# QuickDocsPHP

This extension provides a quick documentation to each php function and to some php predefined classes.

You can also add your own docs: [User defined functions](#user-defined-function-documentation) 

## How to use

You can use the Navigation menu or ```Ctrl+K``` (Windows) or ```CMD+K``` (Mac), while your cursor is on a php function, to open the inline documentation.

![Example](image/example.png?raw=true)

This extension uses the documentation from [http://php.net](http://php.net).

## User defined function documentation

Use PHPDoc to document your own functions and get inline documentations as well.

It's also working if your own function isn't part of your current document but inside a php class.

If the function is inside a php class it is important, that the filename contains the classname! 

![InlineDocs](image/user_func.png?raw=true)

The php class inside an other file (`class.table2array.php`):

![PHP-class](image/user_func_class.png?raw=true)

## You're rich?

You don't need a second yacht and have some coins to spend? Here I am :)

[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=Wikunia&url=https://github.com/Wikunia/brackets-QuickDocsPHP&title=Brackets-QuickDocsPHP&language=javascript&tags=github&category=software)

[![Donate! :3](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=B5VQXWCZXYN2W)

##The documentation includes

+ description

+ syntax

+ return

+ parameters

 + title

 + description

##PHP Classes

+ DateTime

+ ArrayObject

##Languages

+ English

+ German

+ Spanish

+ French

### License

Creative Commons v3.0

[http://creativecommons.org/licenses/by/3.0/](http://creativecommons.org/licenses/by/3.0/)