Inline short documentation for PHP functions, including a summary and parameters.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
image
InlineDocsViewer.html
InlineDocsViewer.js
Readme.md
WebPlatformDocsPHP.less
main.js
package.json

Readme.md

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

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

This extension uses the documentation from 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

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

You're rich?

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

Flattr this git repo Donate! :3

##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/