Permalink
Browse files

Revert "deprecated"

This reverts commit a11630f.
  • Loading branch information...
1 parent a0c91cf commit d3e08a4dfc8364f6b57247c0ece47be196f0f764 @rayburgemeestre committed May 19, 2016
Showing with 84 additions and 1 deletion.
  1. +84 −1 README.md
View
@@ -1 +1,84 @@
-No more maintaining. Use [phpfold.vim](https://github.com/phpvim/phpfold.vim) instead.
+Abstract
+===============
+
+This is a mirror of http://www.vim.org/scripts/script.php?script_id=1623
+
+This script can fold PHP functions and/or classes, properties with their phpdoc
+without manually adding marker style folds ({{{ and }}}).
+It will generate the following folds when executed:
+
+```
+<?php
+/**
+ * This is Foo...
+ * @author Foo
+ */
+class Foo
+{
++-- 11 lines: function foo($bar) ** -------------------------------------------------
++-- 8 lines: function bar($bar) ** -------------------------------------------------
++-- 24 lines: function baz($bar) ----------------------------------------------------
+}
+?>
+```
+
+Based on e.g. functions declared like this:
+
+```
+<?php
+/**
+* This is fooFunction...
+*
+* @param mixed $bar
+* @access public
+* @return void
+*/
+function fooFunction($bar)
+{
+ ...
+}
+?>
+```
+
+SCREENSHOT
+----------------
+You can view a screenshot here: http://blog.cppse.nl/phpfolding-vim
+
+FEATURES
+----------------
+- It remembers fold settings. If you add functions and execute the script again,
+ your opened folds will not be closed.
+- It will not be confused by brackets in comment blocks or string literals.
+- The folding of class properties with their PhpDoc comments.
+- The folding of all class properties into one fold.
+- Folding the original marker style folds too.
+- An "**" postfixing the fold indicates PhpDoc is inside (configurable).
+- An "**#@+" postfixing the fold indicates PhpDocBlock is inside (configurable).
+- Empty lines postfixing the folds can be configured to be included in the fold.
+- Nested folds are supported (functions inside functions, etc.)
+- Folding private, public, protected class variables + multi-line param.
+- Foloding the class is now an option disabled by default.
+- Now works properly as ftplugin
+
+FUTURE
+----------------
+- Better 'configurability' as opposed to editting the PHPCustomFolds() function
+ and some "Script configuration" global variables.
+
+CONTRIBUTE / GITHUB
+----------------
+- This project is hosted on github as a mirror through
+ - https://github.com/vim-scripts/phpfolding.vim
+- I do not own vim-scripts, so please fork mine instead:
+ - https://github.com/rayburgemeestre/phpfolding.vim
+
+It's then easier for me to accept pull requests and upload new version(s) here,
+also I cannot put phpfolding.vim in the ftplugin/php directory through the
+vim.org interface.
+
+
+COMPATIBILITY
+--------------
+
+This script is tested successfully with Vim version >= 6.3 on windows and linux
+(With 6.0 it works *sometimes*, I don't recommend using it in that version)

0 comments on commit d3e08a4

Please sign in to comment.