Changeset 3908

Timestamp:

Nov 5, 2007, 7:46:31 PM (16 years ago)

Author:

Martin Svensson

Message:

References #809 Updated javadoc

Location:

trunk

Files:

• build.xml (modified) (1 diff)
• src/webservices/client/java/net/sf/basedb/ws/info/QueryOptions.java (modified) (1 diff)
• src/webservices/server/net/sf/basedb/ws/server/AbstractRPCService.java (modified) (1 diff)
• src/webservices/server/net/sf/basedb/ws/server/ExperimentService.java (modified) (1 diff)
• src/webservices/server/net/sf/basedb/ws/server/ProjectService.java (modified) (1 diff)
• src/webservices/server/net/sf/basedb/ws/server/SessionService.java (modified) (1 diff)

trunk/build.xml

@@ -1088 +1088 @@
     <javadoc
       packagenames="net.sf.basedb.*"
-      sourcepath="${core.src}:${coreplugins.src}:${web.src}:${migrate.src}:${jobagent.src}:${webservices.src}/server"
+      sourcepath="${core.src}:${coreplugins.src}:${web.src}:${migrate.src}:${jobagent.src}:${webservices.src}/server:${webservices.src}/client/java"
       destdir="${doc}/api"
       author="true"

trunk/src/webservices/client/java/net/sf/basedb/ws/info/QueryOptions.java

@@ -86 +86 @@
       @param includeInProject TRUE if items in the active project should be included.
       @param includeOthers TRUE if other users' items should be included.
-      @param restriction A {@link net.sf.basedb.query.Restriction} as a string. 
+      @param restriction A {@link net.sf.basedb.core.query.Restriction} as a string. 
       @param prefix Prefix used in the restriction.
    */

trunk/src/webservices/server/net/sf/basedb/ws/server/AbstractRPCService.java

@@ -77 +77 @@
     Following code shows an example of how to get to the file on the client side:
     <code>
-      OMElement response = .....
-      OMElement fileElement = response.getFirstElement();
-      OMElement dataElement = fileElement.getFirstElement();
-      OMText node = (OMText) dataElement.getFirstOMChild();     
-      DataHandler dataHandler = (DataHandler) node.getDataHandler();    
-      InputStream in = dataHandler.getInputStream();
+      OMElement response = .....<br>
+      OMElement fileElement = response.getFirstElement();<br>
+      OMElement dataElement = fileElement.getFirstElement();<br>
+      OMText node = (OMText) dataElement.getFirstOMChild();<br> 
+      DataHandler dataHandler = (DataHandler) node.getDataHandler();<br>    
+      InputStream in = dataHandler.getInputStream();<br>
      </code>
       @param file File to be attached. 

trunk/src/webservices/server/net/sf/basedb/ws/server/ExperimentService.java

@@ -124 +124 @@
       @param experimentId The id of the experiment to get the rawbioassays from.
       @param qOpt QueryOptions to put on the query when getting the rawbioassays.
-      @return Array with {@link net.sf.basedb.ws.client.info.RawBioAssay}s
+      @return Array with {@link net.sf.basedb.ws.info.RawBioAssayInfo}s
    */
   public RawBioAssayInfo[] getRawBioAssays(String ID, int experimentId, QueryOptions qOpt)

trunk/src/webservices/server/net/sf/basedb/ws/server/ProjectService.java

@@ -36 +36 @@
 /**
   Web service class for Project
-  {@link net.sf.based.core.Project}.
+  {@link net.sf.basedb.core.Project}.
     @author Nicklas, Martin
     @version 2.5

trunk/src/webservices/server/net/sf/basedb/ws/server/SessionService.java

@@ -56 +56 @@
     Service for net.sf.basedb.core.SessionControl#getChallenge()
       @param ID
-      @return
+      @return String A radom string
    */
   public String getChallenge(String ID)