taverna-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stian Soiland-Reyes <st...@apache.org>
Subject JavaDoc for Taverna Server
Date Thu, 04 Jan 2018 17:28:57 GMT
I've had a quick look at the javadoc for Taverna Server, it's quite 
extensive and good coverage - well done, Donal!

http://taverna.staging.apache.org/javadoc/taverna-server/
(mvn javadoc:aggregate on git master today)

Spot any glaring typos?

A couple of packages lack title (missing package-info.java ?)


A couple of reference errors that were flagged by javadoc:
https://gist.github.com/stain/ad5d9cdc144b755962b0fda97d36567c

Most seem to be caused by package name mismatch e.g.
in org.taverna.server.master.api.RunBean
the reference
  {@link RunREST} 
can be fixed to
  {@link org.taverna.server.master.RunREST}


I don't think there's much harm in this missing.


Perhaps ironically the standalone taverna-server client
http://taverna.staging.apache.org/javadoc/taverna-server/org/apache/taverna/server/client/package-summary.html
has least javadoc  - but I added 
http://taverna.staging.apache.org/javadoc/taverna-server/org/apache/taverna/server/client/TavernaServer.html
which makes a good start.



t would be nice to clear some of these before the Taverna Server
release.  Any volunteers? ;-)

-- 
Stian Soiland-Reyes
http://orcid.org/0000-0001-9842-9718


Mime
View raw message