From: Mathieu Baudier <mbaudier@argeo.org>
Date: Tue, 13 Jun 2023 06:10:54 +0000 (+0200)
Subject: Improve documentation
X-Git-Tag: v2.3.18~26
X-Git-Url: http://git.argeo.org/?a=commitdiff_plain;h=8bbdd7218a657cf3d9ee05521c08051d2577e654;p=lgpl%2Fargeo-commons.git

Improve documentation
---

diff --git a/org.argeo.api.acr/src/org/argeo/api/acr/Content.java b/org.argeo.api.acr/src/org/argeo/api/acr/Content.java
index f52ab31b8..d48f583fd 100644
--- a/org.argeo.api.acr/src/org/argeo/api/acr/Content.java
+++ b/org.argeo.api.acr/src/org/argeo/api/acr/Content.java
@@ -242,6 +242,14 @@ public interface Content extends Iterable<Content>, Map<QName, Object> {
 	/*
 	 * ATTR AS STRING
 	 */
+	/**
+	 * Convenience method returning an attribute as a {@link String}.
+	 * 
+	 * @param key the attribute name
+	 * @return the attribute value as a {@link String} or <code>null</code>.
+	 * 
+	 * @see Object#toString()
+	 */
 	default String attr(QName key) {
 		// TODO check String type?
 		Object obj = get(key);
@@ -250,21 +258,29 @@ public interface Content extends Iterable<Content>, Map<QName, Object> {
 		return obj.toString();
 	}
 
+	/**
+	 * Convenience method returning an attribute as a {@link String}.
+	 * 
+	 * @param key the attribute name
+	 * @return the attribute value as a {@link String} or <code>null</code>.
+	 * 
+	 * @see Object#toString()
+	 */
 	default String attr(QNamed key) {
 		return attr(key.qName());
 	}
 
+	/**
+	 * Convenience method returning an attribute as a {@link String}.
+	 * 
+	 * @param key the attribute name
+	 * @return the attribute value as a {@link String} or <code>null</code>.
+	 * 
+	 * @see Object#toString()
+	 */
 	default String attr(String key) {
 		return attr(unqualified(key));
 	}
-//
-//	default String attr(Object key) {
-//		return key != null ? attr(key.toString()) : attr(null);
-//	}
-//
-//	default <A> A get(Object key, Class<A> clss) {
-//		return key != null ? get(key.toString(), clss) : get(null, clss);
-//	}
 
 	/*
 	 * EXPERIMENTAL UNSUPPORTED