Mailinglist Archive: yast-devel (66 mails)

< Previous Next >
Re: [yast-devel] Use YARD as code documentation tool?
On 06/27/2013 09:32 AM, David Majda wrote:
Hi,

in the YCP Killer project we are currently working on transferring
comments from YCP to Ruby. One part of that work is transferring
documentation comments. This brings up the question of what
documentation tool we want to use for YaST code in Ruby in general.

There are two main contenders:

* RDoc [1]
* YARD [2]
... shortened ...
>
From the above, I guess it's obvious that I would like Ruby code in
YaST to use YARD too. Do you agree with that, or do you have any better
ideas?

We already have a hosting [#1] for our documentation because Yast is not just about bultins and libraries. There's plenty of other documentation written in docbook already. On the other hand, "standard" docs place makes sense, and even more after we switch to Ruby.

Any idea how we could create a merged documentation from docbook we have and on of the offered ones?

BTW, it seems that the current docs haven't been updated for a while!

#1 http://doc.opensuse.org/projects/YaST/

Lukas

--

Lukas Ocilka, Cloud & Systems Management Department
SUSE LINUX s.r.o., Praha
--
To unsubscribe, e-mail: yast-devel+unsubscribe@xxxxxxxxxxxx
To contact the owner, e-mail: yast-devel+owner@xxxxxxxxxxxx

< Previous Next >
List Navigation
References