Hi Frank,
sorry that i haven't replied so far, i have read it but i have it simply
forgotten.
I like the idea and i would like to have not only an announcement but
also some kind of introduction. A short description of the purpose and
use cases of the new API etc.
I think it will be helpful if the owner/developer of a new API try to
explain the API to somebody else in detail. Often the first improvements
or general changes can be made before it really goes into the product.
And the documentation should be also available, maybe not complete but
at least a draft. If you try to document an API it has more or less the
same effect as explaining. You think again about your API, what
information is important and essential to use it ...
The user view on an API is very very important. How can and should it be
used, is it intuitive without reading a lot of docu. Is the naming ok
and does it fulfill our naming convention.
We have enough "bad" or "wrong" examples where the API is not intuitive
and the documentation is useless. I would really like to see a little
bit more carefulness for new API's.
I would suggest that we mark a new API message in this mailing list with
API: com.sun.star.whatever.XNewAPI
The message itself should contain ideally a link to a generated IDL
reference docu of the new API (i will try to find a place).
A brief description for what the API is good for etc.
A pseudo or real code snippet showing the usage in practice.
Any comments, additional ideas?
Juergen
Frank Schönheit - Sun Microsystems Germany wrote:
my proposal[1]: why not announcing and discussing this topics directly
in *this* API mailing list? (and let [EMAIL PROTECTED]/
[EMAIL PROTECTED] for internal C++ API or whatever name
you give to the core C++ code)
Nobody else interested in the topic, except Ariel, Bernard, and /me? Is
everybody happy with such things being announced in
[EMAIL PROTECTED] (or, well, not being announced at all)? Jürgen,
do you have an opinion on this?
Ciao
Frank
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
