[sigc] Libsigc++ glossary typos and possible clarifications.




Hi, all.

I was looking at the libsigc++ glossary page:

 http://libsigc.sourceforge.net/glossary.shtml

Is there a specific someone who maintains this page and to whom I can send email directly? Or is it more appropriate for me to send mail to the whole mailing list?

Libsigc++ looks pretty cool to me, and I would like to use it and encourage others to use it as well. But an obstacle to people adopting a new library can be a steep learning curve made worse by unclear and/or messy documentation. So, to clarify things, maybe some or all of the following things in the glossary page should be addressed:

adaptor:   "Function" --> "A function"
adaptor:   "slots"  -->  "slot's"

call: "Process" --> "The process"

callback: how's about "A function (with an associated structure and set of arguments) which can be called and which in turn may call other functions or methods."? Is this what was meant?

connect: "Process"  -->  "The process"

connect: what does it mean to destroy a slot? A slot is defined later as a safe version of a callback. Why should a callback be destroyed when it is put in a callback container (i.e. into a signal?)

emit: what does it mean to "invoke a signal"? Below, a signal is defined as a container. What does it mean to invoke a container?

marshaller:  "Structure"  -->  "A structure"
marshaller:  what is a "multi-callback"?

reference: "attempts to prevent that object from deleting"?? This is not clear. Are you talking about the simple reference mechanism built into C++? If so, that doesn't have anything to do with deleting. Are you talking about reference counting with smart pointers (as in Meyers's "Effective C++")? That might make more sense, but is still not clear.

signal:  "Container" --> "A container"
signal: "emited" --> "emitted". signal: "Container for slots which can be emited"?? What can be emitted? The Container? If so, what does it mean for a container to be emitted? The slots? But the slot definition doesn't explain what it means to emit a slot, and the emit definition talks about invoking a signal, which is a circular definition.

signal handler: What kind of function connected to a signal? Do you mean a slot? Is the signal handler the (safe) callback?

signature:  "function" --> "function."

slot: "Safe" --> "A safe"

Thanks.

Greg






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