moiplabs / moip-php

Biblioteca de integração com o MoIP em PHP
http://labs.moip.com.br/
83 stars 68 forks source link

maior parte do phpDoc completamente errado #30

Closed pocesar closed 11 years ago

pocesar commented 11 years ago

o phpDoc dentro da livraria está completamente confuso. Exemplos:

    /**
     * Method setEnvironment()
     *
     * Define the environment for the API utilization.
     *
     * @param string $environment Only two values supported, 'sandbox' or 'producao'
     */

daí, dentro da função ele testa por 'test' ou [qualquer outra coisa] outro exemplo:

    /**
     * Method setPaymentType()
     *
     * Define the payment's type between 'Unico' or 'Direto'
     *
     * @param string $tipo Can be 'Unico' or 'Direto'
     * @return void
     * @access public
     */

return void na verdade retorna Moip $this. $tipo é checado por

if ($tipo == 'Basic' || $tipo == 'Identification') {

e não 'Unico' ou 'Direto'. A documentação do labs.moip já é bem precária, com essas inconsistencias no phpDoc, dificulta ainda mais a situação. No meu phpStorm, fica cheio de erro por causa que muitas funções tem o return void e quebra o auto-complete. o code inspection do phpStorm mostra que tem pelo menos 119 inconsistências na livraria, o que é bem preocupante para um SDK

pocesar commented 11 years ago

tudo resolvido no pull #32