[Rock-dev] Doc in general

[Matthias Goldhoorn]

Just had a short talk to Leif, i agree it's hard for customers to know 
which package define's what classes/objects/functions (specially for the 
ruby side).

Would it be possible to generate _ONE_ big documentation for ALL ruby 
packages on the buildserver that than could be searched?

Matthias

On 06.09.2013 16:25, Sylvain Joyeux wrote:
> On 09/06/2013 03:05 PM, Leif Christensen wrote:
>> Am 06.09.2013 14:52, schrieb Sascha Arnold:
>>> Hi,
>>>> require 'orocos/log'
>>> should help.
>> That did the trick, thanks a lot.
>>
>> But in general: what is the standard procedure of finding the right
>> require path?
>>
>> - somehow (grep?, api?) find out where the ruby stuff used is defined
>> (in my case [...]/tools/orocos.rb/lib/orocos/log/replay.rb) and take the
>> directory path after lib?
> That's not such a bad procedure.
>
> In principle, the I guess that the package's README should provide that
> information: explaining that there are four "subparts" in orocos.rb
> (orocos, orocos/log, orocos/ros and orocos/async) and how to get each of
> them.
>
> In general, I believe that we would gain a lot if the package's README
> would be displayed in the rock package directory (the way github does
> for git repositories) ... Anyone willing to do this :P ?
>
> Sylvain
> _______________________________________________
> Rock-dev mailing list
> Rock-dev at dfki.de
> http://www.dfki.de/mailman/cgi-bin/listinfo/rock-dev


-- 
  Dipl.-Inf. Matthias Goldhoorn
  Space and Underwater Robotic

  Universität Bremen
  FB 3 - Mathematik und Informatik
  AG Robotik
  Robert-Hooke-Straße 5
  28359 Bremen, Germany

  Tel.:     +49 421 178 45-4193
  Zentrale: +49 421 178 45-6550
  Fax:      +49 421 178 45-4150
  E-Mail:   matthias.goldhoorn at uni-bremen.de

  Weitere Informationen: http://www.informatik.uni-bremen.de/robotik