Skip to content

Incorrect PHPDoc syntax #8

Description

@sitnikovv

Please correct the descriptions in the PHPDoc format to match the PSR-5.
To do this, you need to add its type in front of the variable name, for example:
It was:

/**
* Adds a password to a master key.
* @param $mkey A master key.
* @param $pwd A text password.
* @return true if otherwise operation.
*/
public static function addPassword (CompositeKey $mkey, $pwd)

It became:

/**
* Adds a password to a master key.
* @param CompositeKey $mkey A master key.
* @param string       $pwd  A text password.
* @return true if otherwise operation.
*/
public static function addPassword (CompositeKey $mkey, $pwd)

Without this, it is impossible to write, any normal IDE indicates a type mismatch (for example $pwd):
Expected \KeePassPHP\A, got string (@PARAM $pwd A text password.)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions