[Rock-dev] Doc in general

[Sylvain Joyeux]

On 09/06/2013 04:36 PM, Matthias Goldhoorn wrote:
> 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?
Yes. Making it usable will be a lot harder.

In addition, it won't *actually* tell you which package defines the class.

A much simpler (and probably better) solution is to use google. Our
search bar can definitly get a "search API" category

Examples (not integrated in our search bar, use google directly)

   syskit::dataflow +site:rock-robotics.org
   base::samples::joints +site:rock-robotics.org

*In addition*, the namespace of a class should actually reflect the
package name. For rock packages, the namespace and package names should
even be *the same*

-- 
Sylvain Joyeux (Dr.Ing.)
Senior Researcher

Space & Security Robotics
Underwater Robotics

!!! Achtung, neue Telefonnummer!!!

Standort Bremen:
DFKI GmbH
Robotics Innovation Center
Robert-Hooke-Straße 5
28359 Bremen, Germany

Phone: +49 (0)421 178-454136
Fax:   +49 (0)421 218-454150
E-Mail: robotik at dfki.de

Weitere Informationen: http://www.dfki.de/robotik
-----------------------------------------------------------------------
Deutsches Forschungszentrum fuer Kuenstliche Intelligenz GmbH
Firmensitz: Trippstadter Straße 122, D-67663 Kaiserslautern
Geschaeftsfuehrung: Prof. Dr. Dr. h.c. mult. Wolfgang Wahlster
(Vorsitzender) Dr. Walter Olthoff
Vorsitzender des Aufsichtsrats: Prof. Dr. h.c. Hans A. Aukes
Amtsgericht Kaiserslautern, HRB 2313
Sitz der Gesellschaft: Kaiserslautern (HRB 2313)
USt-Id.Nr.:    DE 148646973
Steuernummer:  19/673/0060/3
-----------------------------------------------------------------------