Commit a0785ba8ee0fc5ebdb0df2a8078bf2e60f6db958

Authored by perry.werneck@gmail.com
1 parent a1511bb0

Iniciando documentação do módulo java

Showing 2 changed files with 29 additions and 1 deletions   Show diff stats
src/java/Makefile.in
@@ -143,6 +143,9 @@ jni3270.h: $(BINDIR)/java/$(PACKAGE_NAME)/terminal.class @@ -143,6 +143,9 @@ jni3270.h: $(BINDIR)/java/$(PACKAGE_NAME)/terminal.class
143 $(JAVAH) -o $@ -classpath $(BINDIR)/java $(PACKAGE_NAME).terminal 143 $(JAVAH) -o $@ -classpath $(BINDIR)/java $(PACKAGE_NAME).terminal
144 144
145 145
  146 +doc: terminal.java
  147 + @javadoc -d doc $^
  148 +
146 install: $(BINRLS)/@DLLPREFIX@jni3270@DLLEXT@ 149 install: $(BINRLS)/@DLLPREFIX@jni3270@DLLEXT@
147 150
148 cleanDebug: clean 151 cleanDebug: clean
@@ -150,4 +153,5 @@ cleanDebug: clean @@ -150,4 +153,5 @@ cleanDebug: clean
150 clean: 153 clean:
151 @rm -fr $(OBJDIR) 154 @rm -fr $(OBJDIR)
152 @rm -fr $(BINDIR) 155 @rm -fr $(BINDIR)
  156 + @rm -fr doc
153 @rm -f jni3270.h 157 @rm -f jni3270.h
src/java/terminal.java
@@ -39,8 +39,20 @@ public class terminal @@ -39,8 +39,20 @@ public class terminal
39 private native int init(String id); 39 private native int init(String id);
40 private native int deinit(); 40 private native int deinit();
41 41
42 - // Get library/extension info 42 + /**
  43 + * Get the current lib3270 version.
  44 + *
  45 + * @return String with the current lib3270 version.
  46 + *
  47 + */
43 public native String get_version(); 48 public native String get_version();
  49 +
  50 + /**
  51 + * Get the current lib3270 revision.
  52 + *
  53 + * @return String with the current lib3270 revision.
  54 + *
  55 + */
44 public native String get_revision(); 56 public native String get_revision();
45 public native String get_encoding(); 57 public native String get_encoding();
46 58
@@ -70,10 +82,22 @@ public class terminal @@ -70,10 +82,22 @@ public class terminal
70 public native int connect(String host, int seconds); 82 public native int connect(String host, int seconds);
71 public native int disconnect(); 83 public native int disconnect();
72 84
  85 + /**
  86 + * Creates a tn3270 terminal without associating it
  87 + * with any pw3270 window.
  88 + *
  89 + */
73 public terminal() { 90 public terminal() {
74 init(); 91 init();
75 } 92 }
76 93
  94 + /**
  95 + * Creates a tn3270 terminal associated with a
  96 + * pw3270 window.
  97 + *
  98 + * @param id String identifying the target window.
  99 + *
  100 + */
77 public terminal(String id) { 101 public terminal(String id) {
78 init(id); 102 init(id);
79 } 103 }