2017 © Pedro PelĆ”ez
 

library frobou-doc-go

Frobou auto generate documentation

image

frobou/frobou-doc-go

Frobou auto generate documentation

  • Friday, August 25, 2017
  • by blobs.frobou
  • Repository
  • 1 Watchers
  • 0 Stars
  • 47 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 1 Open issues
  • 10 Versions
  • 4 % Grown

The README.md

Frobou Doc Go, by frobou

SensioLabsInsight, (*1)

--- readme mal e porcamente escrito, nao Ć© o foco agora..., (*2)

regras:, (*3)

classe deve ter anotacao @endpoint e @name, (*4)

/** * @entrypoint
* @name DocTestClassApi
*/
@entrypoint indica se a classe Ć© um ponto de entrada
@name indica o nome do recurso, (*5)

cada classe apta deve ter anotacoes nos metodos necessarios, exemplo:, (*6)

/**
 * @endpoint
 * @name umnomeaqui
 * @description Manda a carroƧa para algum lugar
 * @method GET
 * @expected {"arg1": "","arg2":"","arg3":""}
 * @field $arg1=decricao do campo
 * @field $arg2=descricao do campo
 * @optfield $arg3=descricao do campo
 * @rule $arg1=deve ser uma string
 * @rule $arg2=deve ser um inteito de 0 a 10
 * @optrule nome=true para pinda, false para monhangaba
 * @obs Para que o recurso funcione Ʃ necessƔrio que use o PHP
 * @example {"arg1": "CarroƧa","arg2":5,"arg3":true}
 * @return {"A carroƧa foi 5 vezes para pinda"}
 */
public function func1($arg1, $arg2, $arg3=false)
{
    return $arg1 + $arg2;
}

para usar faƧa o seguinte:
crie o objeto principal
$api = new FrobouDocApi();
vasculhe uma classe anotada
$obj = $api->getClassDoc(DocTestClassApi::class);
use o array associativo resultante da forma que precisar., (*7)

uma ideia é criar uma anotação @teste teste=(valor1=valor,valor2=valor) e parsear conforme necessÔrio
a imaginação é o limite, (*8)

The Versions

25/08 2017

dev-master

9999999-dev http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

15/06 2017

0.0.9

0.0.9.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

15/06 2017

0.0.8

0.0.8.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

06/01 2017

0.0.7

0.0.7.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

06/01 2017

0.0.6

0.0.6.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

05/01 2017

0.0.5

0.0.5.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

05/01 2017

0.0.4

0.0.4.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

12/12 2016

0.0.3

0.0.3.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

12/12 2016

0.0.2

0.0.2.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta

12/12 2016

0.0.1

0.0.1.0 http://frobou.com.br

Frobou auto generate documentation

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Fabio Pimenta