Ah, that would be brilliant :) Adding package-info.java is always a bit tricky for me in Eclipse as the editor falls a bit apart when you are used to helpful formatting in normal *.java files.
We still need the ASF boilerplate at the top of every file, but don't want it rendered as the javadoc for the package, so perhaps /* */ for the boilerplate, and then /** actualjavadochere */ afterwards above the package line ..at least that's what I thought I did in https://github.com/apache/incubator-taverna-language/blob/master/taverna-scufl2-api/src/main/java/org/apache/taverna/scufl2/api/package-info.java but now I see that file has the ASF legalese **below**! Not sure if this is required or if that was just Eclipse moving things about for me when I clicked Reformat.. On 17 February 2016 at 00:33, Gale Naylor <[email protected]> wrote: > I think it would be useful to replicate your module descriptions. And I > think I could help add the JavaDoc descriptions. > > In looking at the code and JavaDoc, I noticed in one case, most of the > Javadoc text is not showing up in the actual JavaDoc. Is this right? It's > Package org.apache.taverna.configuration.app. The file includes several > lines of description ( > https://github.com/apache/incubator-taverna-osgi/blob/master/taverna-app-configuration-api/src/main/java/org/apache/taverna/configuration/app/ApplicationConfiguration.java), > but in the JavaDoc, only the first line shows up ( > http://taverna.incubator.apache.org/javadoc/taverna-osgi/?overview-summary.html > ). > > > > > > On Mon, Feb 15, 2016 at 3:27 AM Stian Soiland-Reyes (JIRA) <[email protected]> > wrote: > >> >> [ >> https://issues.apache.org/jira/browse/TAVERNA-894?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15147236#comment-15147236 >> ] >> >> Stian Soiland-Reyes commented on TAVERNA-894: >> --------------------------------------------- >> >> I described the modules briefly in >> https://github.com/apache/incubator-taverna-osgi#modules - should some of >> this be replicated into the corresponding package-info.java per package? >> >> > javadoc for taverna-osgi >> > ------------------------ >> > >> > Key: TAVERNA-894 >> > URL: https://issues.apache.org/jira/browse/TAVERNA-894 >> > Project: Apache Taverna >> > Issue Type: Bug >> > Components: Taverna OSGi, Website >> > Reporter: Stian Soiland-Reyes >> > Labels: javadoc >> > Fix For: osgi 0.2.0 >> > >> > >> > taverna-osgi javadocs should be generated published on the website - >> particularly as there are various *-api modules. >> > I've started the upload to >> http://taverna.incubator.apache.org/javadoc/taverna-osgi/ - but I think >> the javadocs themselves might need a quick click-through to see they are >> not too outdated/empty/wrong. >> > Many of them will have @author David Withers as he did most of this work >> as part of Taverna 3 consultancy - but should we remove or keep these kind >> of @author tags under ASF? (David not a committer on Apache Taverna) >> >> >> >> -- >> This message was sent by Atlassian JIRA >> (v6.3.4#6332) >> -- Stian Soiland-Reyes Apache Taverna (incubating), Apache Commons RDF (incubating) http://orcid.org/0000-0001-9842-9718
