Documentation available in wiki



Hi all,
    The beagle-client API documentation is now available at
http://beagle-project.org/doc/
    (Thanks Kevin Kubasik for hosting it previously). The
beagle-client API is all you need to talk to beagled, for querying,
submitting data for indexing or retrieving various information. Both
the C API (called libbeagle) and C# API (called BeagleClient) are
available. The C# documentation is work in progress, it shows the API
classes and methods but none of the descriptions are filled in. The
python API is based on libbeagle directly, use libbeagle docs for its
reference.
    libbeagle docs are generated from the inline comments in libbeagle
source while BeagleClient docs are generated from the documentation
stored separately in /trunk/beagle/doc. If you notice any error in the
documentation, please let us know. If you want to send us a patch, you
now know the source of the documentation :)

- dBera

-- 
-----------------------------------------------------
Debajyoti Bera @ http://dtecht.blogspot.com
beagle / KDE fan
Mandriva / Inspiron-1100 user



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]