[yast-devel] Webyast - generated documentation
Hi, in short: look at http://w3.suse.de/~jreidinger/webservice http://w3.suse.de/~jreidinger/webclient and if you find that your plugin missing certainly amount of comments, you should improve it. It is now only on internal site (but anyone can generate it in git), but in future I hope we find some suitable place for this documentation. Also it is generated manually by me, as there is some problems with hudson. If documenation missing then your plugin cannot generate documentation by rake app:doc some details: I add to Rakefile task to generate documentation of framework and its plugins. rake doc (at top level directory). It uses rake app:doc in each plugin directory and copy it to one place where is dynamically generated index file. Webclient framework missing documentation, I plan to fix it. I welcome any suggestion on improvements. -- Josef Reidinger YaST team maintainer of perl-Bootloader, YaST2-Repair, webyast modules language and time -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org For additional commands, e-mail: yast-devel+help@opensuse.org
* Josef Reidinger <jreidinger@suse.cz> [Oct 20. 2009 16:21]:
Hi,
in short: look at http://w3.suse.de/~jreidinger/webservice http://w3.suse.de/~jreidinger/webclient
Now thats nice. Thanks ! Klaus --- SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nürnberg) -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org For additional commands, e-mail: yast-devel+help@opensuse.org
Now it is accessible also outside. http://www.suse.de/~jreidinger/webservice http://www.suse.de/~jreidinger/webclient it is still manually generated by me, so any changes is not automatic reflected. Josef Reidinger write:
Hi,
in short: look at http://w3.suse.de/~jreidinger/webservice http://w3.suse.de/~jreidinger/webclient and if you find that your plugin missing certainly amount of comments, you should improve it. It is now only on internal site (but anyone can generate it in git), but in future I hope we find some suitable place for this documentation. Also it is generated manually by me, as there is some problems with hudson. If documenation missing then your plugin cannot generate documentation by rake app:doc
some details: I add to Rakefile task to generate documentation of framework and its plugins. rake doc (at top level directory). It uses rake app:doc in each plugin directory and copy it to one place where is dynamically generated index file. Webclient framework missing documentation, I plan to fix it.
I welcome any suggestion on improvements.
-- Josef Reidinger YaST team maintainer of perl-Bootloader, YaST2-Repair, webyast modules language and time -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org For additional commands, e-mail: yast-devel+help@opensuse.org
On Tuesday 20 October 2009 16:54:03 Josef Reidinger wrote:
Now it is accessible also outside.
http://www.suse.de/~jreidinger/webservice http://www.suse.de/~jreidinger/webclient
nice Do you know how to change the template to something like the one http://rdoc.info uses? Duncan -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org For additional commands, e-mail: yast-devel+help@opensuse.org
Duncan Mac-Vicar Prett napsal(a):
On Tuesday 20 October 2009 16:54:03 Josef Reidinger wrote:
Now it is accessible also outside.
http://www.suse.de/~jreidinger/webservice http://www.suse.de/~jreidinger/webclient
nice
Do you know how to change the template to something like the one http://rdoc.info uses?
Duncan
I must look how they do it, but I found that they use yard for documentation purpose and I must say, that I like it. Especially yard params and dynamic calls documentation is really cool. http://yard.soen.ca/what_is.html And it is compatible with rdoc, so I suggest to start using it. Josef -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org For additional commands, e-mail: yast-devel+help@opensuse.org
* Duncan Mac-Vicar Prett <dmacvicar@suse.de> [Oct 21. 2009 11:23]:
On Tuesday 20 October 2009 16:54:03 Josef Reidinger wrote:
Now it is accessible also outside.
http://www.suse.de/~jreidinger/webservice http://www.suse.de/~jreidinger/webclient
nice
Do you know how to change the template to something like the one http://rdoc.info uses?
Upgrade to Ruby 1.9 ;-) (rdoc bundled in Ruby 1.9 has huge changes in its output style. I don't know if rdoc.info is based on that.) Klaus --- SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nürnberg) -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org For additional commands, e-mail: yast-devel+help@opensuse.org
participants (4)
-
Duncan Mac-Vicar Prett
-
Josef Reidinger
-
josef reidinger
-
Klaus Kaempf