ソースを参照

Amélioration documentation

Arthur Brandao 6 年 前
コミット
b98392c2be
1 ファイル変更12 行追加0 行削除
  1. 12 0
      src/migl/lisp/LispElement.java

+ 12 - 0
src/migl/lisp/LispElement.java

@@ -24,6 +24,7 @@ public class LispElement<E> {
 
 	/**
 	 * Constructeur privée pour construire un element à partir de valueOf
+	 * 
 	 * @param val
 	 */
 	private LispElement(E val) {
@@ -31,6 +32,12 @@ public class LispElement<E> {
 		cache.put(val, this);
 	}
 	
+	/**
+	 * Retourne la valeur d'un element sous forme d'entier
+	 * 
+	 * @throws IllegalStateException Si l'element ne peut pas être converti en BigInteger
+	 * @return
+	 */
 	public BigInteger toInt() {
 		if(this.value.getClass() == BigInteger.class) {
 			return (BigInteger) this.value;
@@ -41,6 +48,7 @@ public class LispElement<E> {
 	/**
 	 * Retourne la valeur d'un element sous forme de nombre
 	 * 
+	 * Si l'element ne peut pas être converti en Double
 	 * @return
 	 */
 	public double toNumber() {
@@ -56,6 +64,7 @@ public class LispElement<E> {
 	/**
 	 * Retourne la valeur d'un element sous forme de boolean
 	 * 
+	 * Si l'element ne peut pas être converti en boolean
 	 * @return
 	 */
 	public boolean toBoolean() {
@@ -69,6 +78,7 @@ public class LispElement<E> {
 	/**
 	 * Retourne la valeur d'un element sous forme de string
 	 * 
+	 * Si l'element ne peut pas être converti en String
 	 * @return
 	 */
 	public String toStr() {
@@ -95,6 +105,7 @@ public class LispElement<E> {
 
 	/**
 	 * Parse un element
+	 * 
 	 * @param elt L'element à parser
 	 * @return Un LispElement contenant la valeur extraite
 	 */
@@ -119,6 +130,7 @@ public class LispElement<E> {
 	
 	/**
 	 * Genere un LispElement correspondant à l'objet
+	 * 
 	 * @param elt
 	 * @return
 	 */