Re: [DrJava] Documentation Documentation

[Charles R. <creis@u.washington.edu>]

   So I seem to have forgotten about this issue for many months, but I 
have just committed a new version of the developer documentation (and 
updated the DrJava website) with instructions on how to update the 
documentation, along with a new chapter for adding tips to other 
developers as they come up.  Please feel free to add to it!  (Note that 
you need docbook2html installed to generate the documentation.)

   It might also be nice to have a brief chapter with a very high level 
overview of the code base.  I've written emails to that effect before, 
so I'll try to dig one up and add it to the documentation.  (Don't want 
to get too specific, because we do a lot of refactoring and it could get 
out of date quickly.)

Hope that helps!
Charlie


Peter Centgraf wrote:
> Hi all,
> 
> I'm interested in tweaking some of the DrJava documentation, 
> specifically as regards recently added/changed features from this 
> summer's work.  However, I haven't the foggiest clue how to do that.  I 
> don't even remember what format the docs are originally authored in 
> (DocBook maybe?).  If someone who knows (perhaps only Charlie) could 
> whip up a quick section on editing the docs (what software is needed, 
> how to generate the HTML and PDF) and put it in the developer docs 
> online, I would appreciate it much.
> 
> -- 
> Peter