[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

dh_javadoc



Hi,
  I've recently adopted the gjdoc packages and have been doing quite a
bit of work on them. My testing shows that the gjdoc-native package
seems to work very well for most purposes. The java bytecode version in
the gjdoc package still doesn't work. There also still exist a number of
issues (including missing features) from upstream.

  With the possibility of eventually having some central location for
javadoc listings so that they can all interlink, I have created a
debhelper script, dh_javadoc, for creating and installing javadoc
documentation. This is available at the moment in both gjdoc packages.
At present, this does no more than create and install documentation in
the packages doc dir, however use of it should ensure future
compatibility with any possible policy changes regarding documentation. 
Please try dh_javadoc in your packages and report your successes. 

If you do encounter problems, please do file bug reports. gjdoc isn't a
perfect source, so there is lots of scope for improvement - it would be
helpful to direct our effort to where it is needed. If anyone is
interested in helping resolve any of the issues (gjdoc is written in
Java, with limited comments), then all help would be appreciated.
Current known issues are:

- Java bytecode package isn't working
- xslt processor doesn't convert escaped characters back to their
original form.
- gjdoc has problems finding classes when they are interfaces. 
- feature requests: overview.html file; -link option. 

I have been in contact with upstream, however they all have very limited
time and nobody seems to be regularly working on gjdoc. 

-- 
  .''`. Mark Howard
 : :' :
 `. `'  http://www.tildemh.com 
   `-   mh@debian.org | mh@tildemh.com | mh344@cam.ac.uk 



Reply to: