updated methods javadoc

src/main/java/org/gcube/data/publishing/ckan2zenodo/Ckan2Zenodo.java

@@ -9,16 +9,64 @@ import org.gcube.data.publishing.ckan2zenodo.model.zenodo.ZenodoDeposition;
 
 public interface Ckan2Zenodo {
 
+	
+	/**
+	 * Instantiates default implementation
+	 * 
+	 * @return
+	 */
 	public static Ckan2Zenodo get() {
 		return null;
 	}
 	
-	
+	/**
+	 * Loads a CkanItem identified by @param itemName from current VRE gCat
+	 * 
+	 * @param itemName
+	 * @return
+	 */
 	public CkanItemDescriptor read(String itemName);
+	
+	/**
+	 * Translates @param desc into a ZenodoDeposition using mappings declared in current VRE
+	 * 
+	 * @param desc
+	 * @return
+	 */
 	public ZenodoDeposition translate(CkanItemDescriptor desc);
+	
+	/**
+	 * Create / update metadata of @param toUpdate into the Zenodo instance declared in current VRE
+	 * 
+	 * @param toUpdate
+	 * @return
+	 */
 	public ZenodoDeposition updatedMetadata(ZenodoDeposition toUpdate);
+	
+	/**
+	 * Filters ckan resources of @param desc by using mappings declared in current VRE 
+	 * 
+	 * @param desc
+	 * @return
+	 */
 	public CkanResource filterResources(CkanItemDescriptor desc);
-	public Future<ZenodoDeposition> uploadFiles(Set<CkanResource> toUpload,ZenodoDeposition deposition); 
+	
+	/**
+	 * Uploads @param toUpload resources associating them to given @param deposition
+	 * 
+	 * @param toUpload
+	 * @param deposition
+	 * @return
+	 */
+	public Future<ZenodoDeposition> uploadFiles(Set<CkanResource> toUpload,ZenodoDeposition deposition);
+	
+	/**
+	 * Publishes @param dep, setting/updateing DOI reference into @param toUpdate
+	 * 
+	 * @param dep
+	 * @param toUpdate
+	 * @return
+	 */
 	public ZenodoDeposition publish(ZenodoDeposition dep, CkanItemDescriptor toUpdate);
 		
 }