Prepare changelog for release

CHANGELOG.md

@@ -1,3 +1,275 @@
+2020-10-23: Version 3.0.0
+
+# ADDED
+
+- Allow customization of css, thanks to [Jaapio]
+- Filter unresolved interfaces, thanks to [Jaapio]
+- Add missing function location to xml template, thanks to [Jaapio]
+- Fix issues in structure.xml, thanks to [Jaapio]
+- Reintroduce xml structure file, thanks to [Jaapio]
+- Add Visibility on ConstantDescriptor and constantAssembler, thanks to [Orklah]
+- Improve test for the Template class, thanks to [Mike van Riel]
+- Add Files index and make more extendible, thanks to [Mike van Riel]
+- Render Collection Types as links, thanks to [Jaapio]
+- Add border to default template sidebar, thanks to [Jaapio]
+- Disable caching of twig templates and always enable debug, thanks to [Mike van Riel]
+- Redesign header, thanks to [Mike van Riel]
+- More styling of the default template, and include title in the config xsd, thanks to [Mike van Riel]
+- Redesign sidebar / navigation for default template, thanks to [Mike van Riel]
+- Add private and protected icons to table of contents, thanks to [Mike van Riel]
+- Push updates for table-of-contents, thanks to [Mike van Riel]
+- Split templates into smaller templates, thanks to [Mike van Riel]
+- Extract TOC entries to separate template, thanks to [Mike van Riel]
+- Signature should be styled more according to code, thanks to [Mike van Riel]
+- Re-add $ and () to toc entries, thanks to [Mike van Riel]
+- Remove prettify from Javascripts, thanks to [Mike van Riel]
+- Split methods and properties into sub-templates for re-use, thanks to [Mike van Riel]
+- Restructure CSS, thanks to [Mike van Riel]
+- Clean up namespaces, packages and index template files, thanks to [Mike van Riel]
+- Replace namespace and file templates' contents with components, thanks to [Mike van Riel]
+- Add back to top + various changes, thanks to [Mike van Riel]
+- Cache-bust assets in demo application, thanks to [Mike van Riel]
+- Update screenshot for demo, thanks to [Mike van Riel]
+- Integrated RST-Parser into phpDocumentor for faster iterations, thanks to [Mike van Riel]
+- [GUIDES] Move more and more dependencies up, thanks to [Mike van Riel]
+- Replaced custom error handling with logger for Guides, thanks to [Mike van Riel]
+- Refactor custom twig away from Guides and consolidate templates, thanks to [Mike van Riel]
+- Refactor Guides to simplify Depenency Injection, thanks to [Mike van Riel]
+- [GUIDES] Separate generic from restructuredtext specific code, thanks to [Mike van Riel]
+- [GUIDES] Read input from Flysystem, thanks to [Mike van Riel]
+- Migrate phpDocumentor\Descriptor\Filter to Prophecy, thanks to [martzd]
+- Extract parsing of a file into a separate command and handler, thanks to [Mike van Riel]
+- [GUIDES] Use FlySystem for writing output to, thanks to [Mike van Riel]
+- [GUIDES] Move parsing to the parser phase, thanks to [Mike van Riel]
+- [GUIDES] Separate parsing and rendering even more, thanks to [Mike van Riel]
+- [GUIDES] move more services to the front and into the container, thanks to [Mike van Riel]
+- [GUIDES] Shuffle code around to simplify dependencies more, thanks to [Mike van Riel]
+- [GUIDES] Refactor the Kernel out as to split parsing and rendering, thanks to [Mike van Riel]
+- Reintroduce important, note and warning directive and fix paths, thanks to [Mike van Riel]
+- Move caching of guides into the pipeline, thanks to [Mike van Riel]
+- [GUIDES] URLs between all pages and api documentation work, thanks to [Mike van Riel]
+- [GUIDES] Add test for Entry, thanks to [Mike van Riel]
+- [GUIDES] Enable Psalm, thanks to [Mike van Riel]
+- [GUIDES] Enable phpstan and phpcs checks, thanks to [Mike van Riel]
+- [Guides] Enable phpstan, thanks to [Mike van Riel]
+- Introduce ApiSetDescriptors, thanks to [Mike van Riel]
+- Only build Guides in the RenderGuide writer, thanks to [Mike van Riel]
+- Render documentation with phpDocumentor, not Sphinx, thanks to [Mike van Riel]
+- Remove build asset step as it is not really used and fails the build, thanks to [Mike van Riel]
+- Disable cache for guides, thanks to [Mike van Riel]
+- Replace markdown parser with CommonMark, thanks to [Jaapio]
+
+# REMOVED
+
+- Remove redundant functions and add tests, thanks to [Mike van Riel]
+- Remove redundant setters and complete test, thanks to [Mike van Riel]
+- Remove suggestion to install Twig PHP extension, thanks to [Mike van Riel]
+- Remove Behat from the build, thanks to [Mike van Riel]
+
+# FIXED
+
+- Template Default: normalize the section headers, thanks to [jrfnl]
+- Fix include of tags in function, thanks to [Jaapio]
+- Move search input to top, thanks to [Mike van Riel]
+- Resrtructure TOC to use DL instead of table, thanks to [Mike van Riel]
+- Moved CSS around and tweaked design of topnav, thanks to [Mike van Riel]
+- Move TOC, Breadcrumbs and tags into components, thanks to [Mike van Riel
+- Cleanup extension list (origin/php-extensions, php-extensions), thanks to [Jaapio]
+- Escape html in markdown, thanks to [Jaapio]
+- Improve docblock tag rendering, thanks to [Jaapio]
+- ConstantDescriptor can't have FileDescriptor as parent, thanks to [Orklah]
+- Fix usage for numeric version number, thanks to [Jaapio]
+- Fix version and since tags in default template, thanks to [Jaapio]
+- make getTypes never return null values, thanks to [Orklah]
+- Ensure that phpDocumentor2 Wildcards are expanded, thanks to [Mike van Riel]
+- Fix issue with invalid named magic properties, thanks to [Jaapio]
+- Use title and template from v2 config, thanks to [Jaapio]
+- Property descriptor is in markdown format, thanks to [Jaapio]
+- Internal is additional to the other visibilties, thanks to [Jaapio]
+- Remove ext-ctype from suggest because it's already required, thanks to [Randy Geraads]
+- XSD: update phpdoc.org URL to https, thanks to [jrfnl]
+- Fixes #2442: show 'mixed' in TOC for properties without type, thanks to [Mike van Riel]
+- Constant values in TOC should be singleline, thanks to [Mike van Riel]
+- Constants should not show a dollar sign in signature, thanks to [Mike van Riel]
+- Correctly render links to FQSEN references, thanks to [Mike van Riel]
+- Property default value of 0 is shown as an empty string, thanks to [Mike van Riel]
+- Prevent duplicate methods, properties and constants, thanks to [Mike van Riel]
+- Add deeplinks and tweak grid, thanks to [Mike van Riel]
+- Simplify the grid classes and match standards, thanks to [Mike van Riel]
+- Fixes #2457: Do not show global namespace when empty, thanks to [Mike van Riel]
+- Various changes to the default template, thanks to [Mike van Riel]
+- Remove slashes from default values, thanks to [Jaapio]
+- Revert added slashes to constant value, thanks to [Jaapio]
+- Fix graph path, thanks to [Jaapio]
+- Fix issues after parsing vendor dir, thanks to [Jaapio]
+- fix syntax error on base template, thanks to [Jaapio]
+- Improve link rendering for list like types, thanks to [Jaapio]
+- Fix display of return type and param description, thanks to [Jaapio]
+- prevent PHP error. Reason: type parameter for magic property can be null, thanks to [Axel Krysztofiak]
+- fixed phpstan error, thanks to [Randy Geraads]
+- Partially fix strip inline tags, thanks to [Jaapio]
+- Add testcase for issue #2425, thanks to [Jaapio]
+- Allow null descriptions, thanks to [Jaapio]
+- Update CSS with missing parts from website and update docs, thanks to [Mike van Riel]
+- Update demo site's styling, thanks to [Mike van Riel]
+- Fix link rendering, thanks to [Jaapio]
+- Fix namespace defined constants (origin/fix-namespace-constants), thanks to [Jaapio]
+- Apply short notation of elements by default, thanks to [Jaapio]
+- Fixes duplicated logs, thanks to [Jaapio]
+- Ensure traits are part of a namespace, thanks to [Jaapio]
+- Add builder to reducers, thanks to [Jaapio]
+- Fix check for reducer injection, thanks to [Jaapio]
+- Reintroduce examples in config and cli, thanks to [Jaapio]
+- Losen xsd order, thanks to [Jaapio]
+- [GUIDES] Change url linking to make menu work better, thanks to [Mike van Riel]
+- Ensure guides are rendered in the correct location, thanks to [Mike van Riel]
+- Extend list of default config file names, thanks to [Jaapio]
+- Allow multiple visibilities, thanks to [Jaapio]
+- Remove manditory paths setting, thanks to [Jaapio]
+- Fix filter constants, thanks to [Jaapio]
+- Add tests for visiblity, thanks to [Jaapio]
+- Fix commandline argument ignore-tags, thanks to [Jaapio]
+- Update our own config to ignore tags, thanks to [Jaapio]
+- Add strip tags filter, thanks to [Jaapio]
+- Fix configuration loading for ignore-tags, thanks to [Jaapio]
+- Improve creation of element filters, thanks to [Jaapio]
+- Include blockquote and fix height in navbar, thanks to [Mike van Riel]
+- GH#2493 Search links do not resolve on the homepage, thanks to [Mike van Riel]
+- Default template does not have responsiveness, thanks to [Mike van Riel]
+- Tweak navigation, thanks to [Mike van Riel]
+- Removed event dispatching from Node and wrote test, thanks to [Mike van Riel]
+- Add default for null values, thanks to [Jaapio]
+- Resolve style issues (origin/bugfix/2493), thanks to [Mike van Riel]
+- Resolve last issues in default template, thanks to [Mike van Riel]
+
+# Security
+
+- Update Cypress to resolve security issues, thanks to [Mike van Riel]
+- Updated http-foundation to resolve reported security issues, thanks to [Mike van Riel]
+
+# DOCS
+
+- Improve layout of comment after "your environment", thanks to [HonkingGoose]
+- Improve bug report template, thanks to [HonkingGoose]]
+- Add whitespace for readability, thanks to [HonkingGoose]
+- Use proper casing for the word GitHub, thanks to [HonkingGoose]
+- Update README.md, thanks to [HonkingGoose]
+- Cleanup docs, thanks to [Jaapio]
+- Add filesystem docs, thanks to [Jaapio]
+- Fix even more links in docs, thanks to [Mike van Riel]
+- Fix documentation links, thanks to [Mike van Riel]
+- Fix typos in docs, thanks to [Mike van Riel]
+- Improve FileDescriptor docs, thanks to [Jaapio]
+- Add tags to improve api docs for templates, thanks to [Jaapio]
+- Add hint about plaintext summaries, thanks to [Jaapio]
+- Small doc improvements, thanks to [Jaapio]
+- Removed all 'under construction' pages, thanks to [Mike van Riel]
+- Docs: improvements for "getting started - changing the look and feel", thanks to [jrfnl]
+- Docs: further improvements for "getting started - installing", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - internal", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - version", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - var", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - todo", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - throws", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - subpackage", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - see", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - filesource", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - deprecated", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - copyright", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - category", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - package", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - link", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - license", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - ignore", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - author", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - api", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - property[<-read|-write>]", thanks to [jrfnl]
+- Docs: improvements for "getting started - your first set of documentation", thanks to [jrfnl]
+- Docs: improvements for "references - phpdoc - tags - method", thanks to [jrfnl]
+- Docs: improvements for "getting started - installing", thanks to [jrfnl]
+- Docs: fix various links [public facing], thanks to [jrfnl]
+- Fix references to the phpdoc.org website [test fixtures], thanks to [jrfnl]
+- Fix references to the phpdoc.org website [test file docblocks], thanks to [jrfnl]
+- Fix references to the phpdoc.org website [src file docblocks], thanks to [jrfnl]
+- Fix references to the phpdoc.org website [templates], thanks to [jrfnl]
+- Fix references to the phpdoc.org website [docs website], thanks to [jrfnl]
+- Fix references to the phpdoc.org website [public facing], thanks to [jrfnl]
+- Docs: remove `:term:` annotations, thanks to [jrfnl]
+- Inline docs: php.net - use language agnostic links and more, thanks to [jrfnl]
+- Docs: php.net - use language agnostic links and more, thanks to [jrfnl]
+- Docs: include instead of duplicate for "index", thanks to [jrfnl]
+- Docs: consistency in referring to the project, thanks to [jrfnl]
+- Template files: remove a broken link, thanks to [jrfnl]
+- Template files: fix various links, thanks to [jrfnl]
+- add option for creating class diagram in the docs, thanks to [Subhojit Paul]
+- Fix internal tag filtering, thanks to [Jaapio]
+- Fix covers annotations, thanks to [Jaapio]
+- Fix more tests and example rendering, thanks to [Jaapio]
+- Advanced inline tag rendering, thanks to [Jaapio]
+- Fix all descriptor tests, thanks to [Jaapio]
+- Expirment with description filter, thanks to [Jaapio]
+- Disable compiler passes right now, thanks to [Jaapio]
+- Switch to Description object, thanks to [Jaapio]
+- Add documentation for custom settings, thanks to [Mike van Riel]
+- Update documentation for guides, thanks to [Mike van Riel]
+- Update readme to prepare for v3, thanks to [Jaapio]
+
+
+# CI
+
+- Composer v2.0: remove `--no-suggest flag` as its going to be deprecated, thanks to [HonkingGoose]
+- Add Docker to .dependabot/config.yml, thanks to [HonkingGoose]
+- removed unused imports, thanks to [Randy Geraads]
+- Add test for ProvideTemplateOverridePathMiddleware, thanks to [Mike van Riel]
+- Improve ci cache, thanks to [Jaap van Otterdijk]
+- Add unittest for flysystem loader, thanks to [Jaapio]
+- Add npm to dependabot, thanks to [Jaapio]
+- Add checker for broken doc links, thanks to [Jaapio]
+- Add psalm to phive, thanks to [Jaapio]
+- Improve ci pipeline setup, thanks to [Jaapio]
+- add strict_types when missing, thanks to [Orklah]
+- add param types where possible, thanks to [Orklah]
+- small fixes. Preparation for Psalm, thanks to [Orklah]
+- psalm improvements, thanks to [Orklah]
+- Migrate phpDocumentor\{Parser, Event, Pipeline} from Mockery to Prophecy, thanks to [simivar]
+- Migrate phpDocumentor\Transformer from Mockery to Prophecy, thanks to [simivar]
+- CI: allow Cypress tests to pass, thanks to [jrfnl]
+- PHPCS config: minor tweaks, thanks to [jrfnl]
+- fix psalm issues on last version, thanks to [Orklah]
+- ignore TooManyTemplate error on Compiler because Psalm doesn't yet expect template annotation to SplPriorityQueue, thanks to [Orklah]
+- add template annotations on Compiler, thanks to [Orklah]
+- ignore phpstan false-positive until the bugfix, thanks to [Randy Geraads]
+- Command to pull the latest docker containers used in the Makefile, thanks to [Randy Geraads]
+- File docblocks: remove license tags, thanks to [jrfnl]
+- Bump release flow to phar action (origin/phar-action, phar-action), thanks to [Jaapio]
+- Start using phar github action, thanks to [Jaapio]
+- Fix composer.lock after update, thanks to [Jaapio]
+- Bump to composer 2, thanks to [Jaapio]
+- Publish NPM package with assets, thanks to [Mike van Riel]
+- Invalid breakpoint used, causing CSS to go wonky, thanks to [Mike van Riel]
+- Re-enable windows testing, thanks to [Jaapio]
+- Enable github-actions updates via Dependabot, thanks to [HonkingGoose]
+- Migrate phpDocumentor\Compiler\Pass from Mockery to Prophecy, thanks to [simivar]
+- Migrate phpDocumentor\Console from Mockery to Prophecy, thanks to [simivar]
+- Migrate test cases that don't use Mockery to PHPUnit's TestCase from MockeryTestCase, thanks to [simivar]
+- Add unit tests for dns, thanks to [Marvin Caspar]
+- Psalm.xml simplification, thanks to [orklah]
+- Migrate phpDocumentor\Descriptor\Builder\Reflector\Tags to Prophecy (#2609), thanks to [martzd]
+- Migrate phpDocumentor\Descriptor\Builder\Reflector to Prophecy (#2607), thanks to [martzd]
+- add details in phpdoc, thanks to [orklah]
+- redundant phpdoc, thanks to [orklah]
+- redundant default parameter value, thanks to [orklah]
+- redundant property initialization, thanks to [orklah]
+- unused variables, thanks to [orklah]
+- use Assert lib instead of native assert, thanks to [orklah]
+- create a MiddlewareInterface and normalize Middlewares, thanks to [orklah]
+- push psalm to level 6, thanks to [orklah]
+- Phpstan doesn't support inheritance of templates + fix various issues, thanks to [orklah]
+- changing templates for coherence, thanks to [orklah]
+- replace static by self and replace className by self when applicable, thanks to [orklah]
+- Rebuild docs when template changes, thanks to [Mike van Riel]
+
+
 2020-02-09: Version 3.0.0-rc
 
 # Removed