Skip to content
Industrial-strength annotations for PHP
Branch: master
Clone or download
Latest commit 5a31c2f Apr 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo Add range annotation to demo Apr 29, 2016
docs
src/annotations slash before php global functions (#121) Apr 28, 2017
test Extract docblocks from members included from traits Jan 14, 2016
.gitignore Packagist integration improvements Aug 18, 2014
.travis.yml Test enhancement May 27, 2018
CHANGELOG.md
README.md Update Project Structure description Apr 11, 2015
composer.json Update branch alias to 1.3 version Feb 15, 2016
composer.lock Packagist integration improvements Aug 18, 2014
lgpl-3.0.txt add folder structure, README and license May 3, 2011
php-doc notes.txt
todo.txt Changes line endings from '\r\n' to '\n' Feb 15, 2014

README.md

php-annotations

Join the chat at https://gitter.im/php-annotations/php-annotations Build Status Scrutinizer Quality Score Code Coverage

Latest Stable Version Total Downloads Latest Unstable Version License

Source-code annotations for PHP.

Copyright (C) 2011-2015 Rasmus Schultz rasmus@mindplay.dk

https://github.com/php-annotations/php-annotations

For documentation and updates, please visit the project Wiki:

http://php-annotations.readthedocs.org/

Project Structure

The files in this project are organized as follows:

php-annotations         This README and the LGPL license
  /src
    /annotations        The core of the library itself
      /standard         Standard library of annotation classes
  /demo                 Browser-based example/demonstration
  /docs                 Documentation files (http://php-annotations.readthedocs.org/en/latest/)
  /test                 Unit tests for the core of the library
    /test.php           Test suite runner
    /annotations        Fixture Annotation types
    /lib                Unit test library
    /runtime            Run-time cache folder used for tests
    /suite              Test cases

The "mindplay" folder is the only folder required for the annotation framework itself - other folders contain demonstration code, tests, etc.

To run the test suite, run "php-annotations/test/test.php" from a browser - a summary of the test-results will be displayed on the page.

Code Style

Largely PSR-2 compliant:

https://raw.github.com/php-fig/fig-standards/master/accepted/PSR-2-coding-style-guide.md

License

http://www.gnu.org/licenses/lgpl-3.0.txt

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, see http://www.gnu.org/licenses.

Additional permission under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or combining it with php-annotations (or a modified version of that library), containing parts covered by the terms of the LGPL, the licensors of this Program grant you additional permission to convey the resulting work.

You can’t perform that action at this time.