Skip to content

Remove unneeded phpdocs #33019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 8, 2019
Merged

Conversation

fabpot
Copy link
Member

@fabpot fabpot commented Aug 7, 2019

Q A
Branch? 4.4
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets n/a
License MIT
Doc PR n/a

@chalasr chalasr added this to the next milestone Aug 7, 2019
@nicolas-grekas nicolas-grekas force-pushed the phpdocs-removal-again branch from 3273208 to 692a6e7 Compare August 8, 2019 09:37
@nicolas-grekas
Copy link
Member

Thank you @fabpot.

@nicolas-grekas nicolas-grekas merged commit 692a6e7 into symfony:4.4 Aug 8, 2019
nicolas-grekas added a commit that referenced this pull request Aug 8, 2019
This PR was squashed before being merged into the 4.4 branch (closes #33019).

Discussion
----------

Remove unneeded phpdocs

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | no <!-- please update src/**/CHANGELOG.md files -->
| BC breaks?    | no     <!-- see https://symfony.com/bc -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets | n/a
| License       | MIT
| Doc PR        | n/a

Commits
-------

692a6e7 Remove unneeded phpdocs
Copy link
Contributor

@kaznovac kaznovac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some impovements

* @param object $subject
* @param Marking $marking
* @param Transition $transition
* @param WorkflowInterface $workflow
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$workflow is not typehinted in _constructor
possible types WorkflowInterface|string|null

* @param Definition $definition A Definition instance
* @param Marking|null $marking A Marking instance
* @param array $options An array of options
* @param array $options An array of options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be removed

* @param string $class The class name of the loaded objects
* @param IdReader|null $idReader The reader for the object IDs
* @param EntityLoaderInterface|null $objectLoader The objects loader
* @param string $class The class name of the loaded objects
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typehinted in constructor maybe surplus

@@ -133,7 +133,6 @@ protected function write($content, $decorated = false)
*
* @param Definition|Alias|object $service
* @param array $options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typehinted

* @param KernelInterface $kernel A KernelInterface instance
* @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
* @param string $rootDir The directory where global templates can be stored
* @param string $rootDir The directory where global templates can be stored
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typehinted maybe needed

@@ -99,7 +99,6 @@ class NativeSessionStorage implements SessionStorageInterface
*
* @param array $options Session configuration options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no additional value

* @param Request $request The request the kernel is currently processing
* @param int $requestType The request type the kernel is currently processing; one of
* HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST
* @param int $requestType The request type the kernel is currently processing; one of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

int|null

* @param \DOMElement $node Element to parse
* @param string $path Full path of the XML file being processed
* @param string $file Loaded file name
* @param \DOMElement $node Element to parse
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inferable

@@ -24,8 +24,7 @@ interface DumperInterface
/**
* Dumps the message catalogue.
*
* @param MessageCatalogue $messages The message catalogue
* @param array $options Options that are used by the dumper
* @param array $options Options that are used by the dumper
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no additional value

* caused the violation
* @param mixed $cause The cause of the violation
* @param string $message The violation message
* @param string $messageTemplate The raw violation message
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lots of |null types can be stated in doc ($message, $messageTemplate, $propertyPath)

nicolas-grekas added a commit that referenced this pull request Aug 8, 2019
…ransformer (Tobion)

This PR was merged into the 4.4 branch.

Discussion
----------

cleanup remaining param $options and internal Intl FullTransformer

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | no <!-- please update src/**/CHANGELOG.md files -->
| BC breaks?    | no     <!-- see https://symfony.com/bc -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets |#...   <!-- #-prefixed issue number(s), if any -->
| License       | MIT
| Doc PR        |

Continuation of #33020 and #33019

Commits
-------

5dbcdc6 cleanup remaining param  and internal Intl FulLTransformer
@nicolas-grekas nicolas-grekas modified the milestones: next, 4.4 Oct 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants