Documentando extensão java

perry.werneck@gmail.com
1 parent 16a57c0c
Showing 1 changed file with 29 additions and 0 deletions Show diff stats
src/java/terminal.java
@@ -54,11 +54,40 @@ public class terminal
 	 *
 	 */
 	public native String	get_revision();
+
+	/**
+	 * Get the current lib3270 encoding.
+	 *
+	 * @return String with the current lib3270 encoding (ISO-8859-1).
+	 *
+	 */
 	public native String	get_encoding();
 	// Get/Set/Text with charset translation
+
+	/**
+	 * Get terminal contents starting at desired address.
+	 *
+	 * @param baddr	Address of the beginning of the string.
+	 * @param len	Length of the string.
+	 *
+	 * @return Terminal contents with "len" bytes starting at "baddr" position.
+	 *
+	 */
 	public native String	get_string(int baddr, int len);
+
+	/**
+	 * Get terminal contents starting at row, col.
+	 *
+	 * @param row	Row of the text.
+	 * @param col	Column of the text.
+	 * @param sz	Size to read.
+	 *
+	 * @return Contents of terminal at row, col with sz bytes.
+	 *
+	 */
 	public native String	get_string_at(int row, int col, int sz);
+
 	public native int		set_string_at(int row, int col, String str);
 	public native int		cmp_string_at(int row, int col, String text);
 	public native int		input_string(String str);
	@@ -54,11 +54,40 @@ public class terminal		@@ -54,11 +54,40 @@ public class terminal
54	*	54	*
55	*/	55	*/
56	public native String get_revision();	56	public native String get_revision();
		57	+
		58	+ /**
		59	+ * Get the current lib3270 encoding.
		60	+ *
		61	+ * @return String with the current lib3270 encoding (ISO-8859-1).
		62	+ *
		63	+ */
57	public native String get_encoding();	64	public native String get_encoding();
58		65
59	// Get/Set/Text with charset translation	66	// Get/Set/Text with charset translation
		67	+
		68	+ /**
		69	+ * Get terminal contents starting at desired address.
		70	+ *
		71	+ * @param baddr Address of the beginning of the string.
		72	+ * @param len Length of the string.
		73	+ *
		74	+ * @return Terminal contents with "len" bytes starting at "baddr" position.
		75	+ *
		76	+ */
60	public native String get_string(int baddr, int len);	77	public native String get_string(int baddr, int len);
		78	+
		79	+ /**
		80	+ * Get terminal contents starting at row, col.
		81	+ *
		82	+ * @param row Row of the text.
		83	+ * @param col Column of the text.
		84	+ * @param sz Size to read.
		85	+ *
		86	+ * @return Contents of terminal at row, col with sz bytes.
		87	+ *
		88	+ */
61	public native String get_string_at(int row, int col, int sz);	89	public native String get_string_at(int row, int col, int sz);
		90	+
62	public native int set_string_at(int row, int col, String str);	91	public native int set_string_at(int row, int col, String str);
63	public native int cmp_string_at(int row, int col, String text);	92	public native int cmp_string_at(int row, int col, String text);
64	public native int input_string(String str);	93	public native int input_string(String str);