docs

Author: ataxexe

src/main/java/org/cafeina/annotations/CaiDeParaquedas.java

@@ -43,6 +43,8 @@
 
   /**
    * Os menos afortunados que caíram no código.
+   *
+   * @return os menos afortunados que caíram no código.
    */
   String[] paraquedistas() default {};
 

src/main/java/org/cafeina/annotations/CodigoHidra.java

@@ -31,17 +31,20 @@
 /**
  * Indica que um código lendário foi introduzido. Prepare-se para atacá-lo e
  * ver que, a cada bug resolvido, vários outros aparecerão.
- *
+ * <p/>
  * Este nome é uma adaptação do termo Hydra Code, bolado por
  * <a href="http://stackoverflow.com/users/108130/nick-dandoulakis">
  * Nick Dandoulakis</a>.
+ *
  * @author Marcelo Guimarães
  */
 @Documented
 public @interface CodigoHidra {
 
   /**
-   * Indica quantos novos bugs são introduzidos para cada bug solucionado.
+   * Indica quantos novos bugs serão introduzidos para cada bug solucionado.
+   *
+   * @return quantos novos bugs serão introduzidos para cada bug solucionado.
    */
   int fatorDeCrescimento() default 2;
 

src/main/java/org/cafeina/annotations/Dejavu.java

@@ -38,6 +38,8 @@
 
   /**
    * Locais onde o código já foi visto aprontando das suas.
+   *
+   * @return locais onde o código já foi visto aprontando das suas.
    */
   String[] locais() default {};
 

src/main/java/org/cafeina/annotations/EuSoEstouDandoManutencao.java

@@ -32,7 +32,7 @@
  * Anotação usada para indicar que você não foi o responsável por nenhuma
  * cagada, apenas corrigiu algum bug (geralmente um carinhoso NPE) ou
  * implementou alguma funcionalidade exótica.
- *
+ * <p/>
  * Esta anotação automaticamente valida qualquer tipo de gambiarra maquiavélica.
  *
  * @author Marcelo Guimarães
@@ -42,6 +42,8 @@
 
   /**
    * Indica os infelizes mantenedores que já se contaminaram com o código.
+   *
+   * @return os infelizes mantenedores que já se contaminaram com o código.
    */
   String[] passouPorAqui() default {};
 

src/main/java/org/cafeina/annotations/FaltaFerro.java

@@ -42,7 +42,9 @@
 public @interface FaltaFerro {
 
   /**
-   * Dieta necessária para acabar com a anemia.
+   * Dieta necessária para acabar com essa anemia.
+   *
+   * @return dieta necessária para acabar com essa anemia.
    */
   AlimentosRicosEmFerro[] consumir() default {};
 

src/main/java/org/cafeina/annotations/IssoDavaUmaLinha.java

@@ -39,11 +39,16 @@
 
   /**
    * Em qual linguagem daria pra fazer isso.
+   *
+   * @return qual linguagem daria pra fazer isso.
    */
   String em();
 
   /**
-   * Mostra como seria (se quiser semear a discórdia, deixe em branco).
+   * Mostra como seria o código nessa linguagem (se quiser semear a discórdia,
+   * deixe em branco).
+   *
+   * @return como seria o código nessa linguagem.
    */
   String olha() default "";
 

src/main/java/org/cafeina/annotations/Macarronada.java

@@ -39,7 +39,9 @@
 public @interface Macarronada {
 
   /**
-   * Define o nível de codificação macarrônica.
+   * Define o nível de codificação macarrônica apresentado.
+   *
+   * @return nível da macarronada.
    */
   IngredientesDaMacarronada[] com() default {};
 

src/main/java/org/cafeina/annotations/Miau.java

@@ -40,6 +40,8 @@
 
   /**
    * Nível da gambiarra.
+   *
+   * @return nível da gambiarra.
    */
   NivelDeMiau nivel() default NivelDeMiau.GATO;
 

src/main/java/org/cafeina/annotations/PraQueEstaMerda.java

@@ -39,6 +39,8 @@
 
   /**
    * Indica uma maneira melhor (se houver) ou uma cagada menos fedorenta.
+   *
+   * @return uma maneira melhor (se houver) ou uma cagada menos fedorenta.
    */
   String se() default "";
 

src/main/java/org/cafeina/annotations/QuandoEuChegueiJaEstavaAssim.java

@@ -40,6 +40,8 @@
 
   /**
    * Indica os pobres mantenedores oprimidos por este código surreal.
+   *
+   * @return pobres mantenedores oprimidos por este código surreal.
    */
   String[] oprimidosPeloSistema() default {};