Code cleanup pass

[defuse]

Look over all the code, check for:

• Unreachable code (e.g. functions that are never called).
• Files without trailing new lines.
• Tabs that should be spaces.
• Consistent capitalization (e.g. some static methods are CamelCase some are whateverThisIsCalled)
• Comments are correct (and all the methods that need documentation have doc comments).

[defuse]

Maybe look up that PSR-2 thing or whatever it is :)

[larowlan]

If you want PSR-2 I'm happy to take this on

[larowlan]

Or if you want something else, still happy to take it on

[defuse]

@larowlan: We want PSR-2. If you're going to do it, do it on top of the branch in #197 since there are some big changes that are about to be merged there.

[larowlan]

Will do
On 5 Apr 2016 6:44 am, "Taylor Hornby" notifications@github.com wrote:

@larowlan https://github.com/larowlan: We want PSR-2. If you're going
to do it, do it on top of the branch in #197
#197 since there are some
big changes that are about to be merged there.

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#198 (comment)

[defuse]

@larowlan Awesome, thanks!

[chriseskow]

I'd recommend using PHP-CS-Fixer, which can automatically modify the code to adhere to PSR-2 standards (among other style changes). You can also add it to composer.json's require-dev and add a .php_cs file to configure it and make it easier to run consistently.

[larowlan]

Great minds think alike ;)
On 5 Apr 2016 7:16 am, "Chris Eskow" notifications@github.com wrote:

I'd recommend using PHP-CS-Fixer
https://github.com/FriendsOfPHP/PHP-CS-Fixer, which can automatically
modify the code to adhere to PSR-2 standards (among other style changes).
You can also add it to composer.json's require-dev and add a .php_cs file
to configure it and make it easier to run consistently.

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#198 (comment)

[defuse]

Fix the comments in File: #212 (comment)

[defuse]

Also make sure the right kind of exception is being thrown (see #216).

[defuse]

What's the standard for those /** doc comments? Is there a tool that can generate good documentation from them so that the "single source of truth" is the comments in the code and the documentation people see is generated?

[defuse]

Only 9 non-test non-exception files. I'll timebox 20 minutes on each one today.

[defuse]

$ ack -i 'TODO|FIXME|HACK|XXX' src/ test/
src/KeyOrPassword.php
57:            // TODO: Is reusing the same $salt between PBKDF2 and HKDF acceptable?

src/Crypto.php
20:     * @param string $key // TODO: this is wrong

test/unit/PasswordTest.php
27:    // TODO more tests (of the checksummed encoding, etc.)

[defuse]

Here's the "standard": https://en.wikipedia.org/wiki/PHPDoc

[defuse]

"The Long Description continues for as many lines as desired and may contain HTML markup for display formatting." loooool nope nope nope

[defuse]

Done in #220.