braintree / braintree_php

Braintree PHP library
https://developer.paypal.com/braintree/docs/start/overview
MIT License
546 stars 224 forks source link

Missing properties in PhpDoc #272

Closed pupitooo closed 2 years ago

pupitooo commented 4 years ago

General information

Issue description

In some classes there are missing properties in PhpDoc. I noticed this:

  1. CreditCard and CreditCardDetails missing some properties - solved by https://github.com/braintree/braintree_php/pull/270

  2. Result Objects allows to acces to objects through properties like:

    $transaction = $result->transaction;

    But there are no properties in phpDoc for this access. It should be fine to add complete list af allowed properties. But I didn't find all list. So if anybody can provide me that list I will complete it in next PR.

hollabaq86 commented 4 years ago

👋 @pupitooo thanks for reaching out (and the PR 😄). Our developer reference docs are the best resources for result objects' properties.

hollabaq86 commented 4 years ago

I'm re-opening this issue because we should add some tests/workflows to keep phpDocs up-to-date. We don't have an ETA on when this will be added, but we can leave this issue open to track interest.

hollabaq86 commented 2 years ago

👋 the latest version (6.5.0) includes some meaningful overhauls to our phpdoc and I wanted to detail some of those decisions, here, so folks have the most context on our changes. This issue was originally created because @property entries were out-dated. We decided to include semantic links to our public developer docs that (should) have complete lists of attributes, instead of using @property notation. We believe this is the better solve long-term for the following reasons:

I hope this helps in understanding our updates! I'm going to close this issue for now, thanks for everyone's patience on getting this work in the SDK.