doxygen and rebranding update

[Xiaofan Chen]

On Wed, Apr 4, 2012 at 1:57 AM, Pete Batard <pete at akeo.ie> wrote:
> On 2012.04.03 17:57, Ludovic Rousseau wrote:
>>
>> libusbx is not just API compatible. It is a _replacement_ of libusb.
>> For example, libusbx will conflict with libusb when packaged. You
>> can't install both at the same time.
>
>
> I'm only considering the API documentation, and the answer to the expected
> question:
> "If I use the libusbx API, how different is it from the libusb one? Are
> there any specifics I should be aware of?"
>
> The idea is that quite a few developers using libusbx and our API would be
> familiar with the libusb one, and will want to find out if we have done any
> drastic change, such as "All libusb_xyz calls have been renamed
> libusbx_xyz".
>
> The fact that libusbx is a replacement for libusb should be answered on the
> main webpage, not in the API doc. But I think the API doc needs to mention
> that switching from libusb 1.0.8 to libusbx is meant to be trivial, as
> existing API calls and structures have not been modified.
>

The main page is not enough. I would put it in the Doxygen Introduction
and README file. The first question users ask is "what is libusbx"?
The first several questions distro packagers ask will be like these.
   What is libusbx?
   What are the advantages compared to libusb?
   Can I package libusbx and libusb-1.0 together?
   What about libusb-compat?


BTW, README should add Ludovic's name.
http://libusbx.git.sourceforge.net/git/gitweb.cgi?p=libusbx/libusbx;a=blob;f=README;hb=HEAD

The Doxygen file is not only API documentation, but also some other
stuff.

http://libusb.sourceforge.net/api-1.0/
libusb-1.0 API Reference is rather a misnomer and I would call our
libusbx doxygen documentation "libusbx documentation".

I think Travis does a good job for the libusbK Doxygen and libusbx
can learn something from that.
http://libusbk.sourceforge.net/UsbK3/index.html



-- 
Xiaofan