docs generator - prereview

[Jiri Vanek]

On 09/04/2014 08:55 PM, Jie Kang wrote:
> ----- Original Message -----
>>
>> 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.
>
>
> Hello,
>
> This patch is really large, is there any way you can split this into smaller iterations? For example, maybe have one patch that moves all paths and files into the PathsAndFiles.java, then one patch for the net.sourceforge.jnlp.docprovider addition, and then another patch for the makefile changes to use the docprovider. As well as a patch for refactoring the 'about dialog'. Or something along those lines;


Right now no. I wonted at first, but the individual changes are so wired together that I failed to 
separate. (not that it is impossible, but that it is too costly)

Also - considering nature of patch,
  - immediately visible result
  - no soemhow at least a bit  important part affected

  I'm very inclined to push it as it is, and tune  on flow.

Except the design itself, the only part needing careful review is  the part refactoring the files.

>
> One thing as well when you look at doing the localization part. Right now Translator just delegates to JNLPRuntime.
>
> e.g:
> public static String R(String message, Object... params) {
>      return JNLPRuntime.getMessage(message, params);
> }
>
> I think we should move the translating parts from JNLPRuntime into Translator. Thoughts?
Maybe? But not inside this already big chngeset :)


J.