Fwd: docs generator - prereview

Jiri Vanek jvanek at redhat.com
Thu Sep 4 15:18:19 UTC 2014


Hi!


  Proudly  :)  presenting... documentation generator for ITW.

Lukas Dracz already seen the preversion, because we shares one peace of code  - 
OptionsDefinitions.java  -  also he  was trying to impelmetn first versions of this.

Now his patch is built on top of this.

Well, it does a lot of things
	- generates man pages and html doc* and palintext docs**
	- unified files declarations
	- unified options declarations

* html docs
    - are usleless in offlien mode (maybe we can publish them on classapth org after each release -
but are used (generated in runtime) in help dialogue - which is really really nice.

** plain text docs - even les susefull then html docs, but are used in runtime commandlinehel/and 
about - which removed all the duplicated string providers.

Various files and properties are sorted in javaws pages, have theyrs defaults and for sure none is
missing.

So finally no duplicated texts in various "about" and "help"!

   The patch is missing localization - I'm going to do so in some next changeset, and I hope to get
rid of RepalcingFormater and its @@ substitution.



As for review - anybody, please be specially careful about the files declaration. I hope I did it 
error-less and complete :(


The design is

1docprovider - have 2formater is providing 3output

eg:
1 -  itw, itw-settings,  javaws...
2  - html, plain, man
3 - man pages (generated during build, loclaized), runtime help - both console and "nice"  html one.
The runtime help have evaluated varibales and properties


For runtime help I had to refactor about dialog a bit - only make some parts singletons and added
an tab....


make check, install, dist and install form dist and unnstall works.



J.





-------------- next part --------------
A non-text attachment was scrubbed...
Name: docsGenerator_2.diff
Type: text/x-patch
Size: 189441 bytes
Desc: not available
URL: <http://mail.openjdk.java.net/pipermail/distro-pkg-dev/attachments/20140904/b8d69f90/docsGenerator_2-0001.diff>


More information about the distro-pkg-dev mailing list