After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 108914 - Docs for Glib::Module
Docs for Glib::Module
Status: RESOLVED FIXED
Product: gtkmm
Classification: Bindings
Component: reference documentation
2.2
Other other
: Normal normal
: ---
Assigned To: gtkmm-forge
gtkmm-forge
Depends on:
Blocks:
 
 
Reported: 2003-03-21 16:45 UTC by Ross Burton
Modified: 2004-12-22 21:47 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
API docs patch (4.59 KB, patch)
2003-03-21 16:58 UTC, Ross Burton
none Details | Review
Updated patch (4.56 KB, patch)
2003-03-24 13:38 UTC, Ross Burton
none Details | Review
Updated patch (4.67 KB, patch)
2003-03-25 11:36 UTC, Ross Burton
none Details | Review

Description Ross Burton 2003-03-21 16:45:23 UTC
API documentation for Glib::Module will be attached.
Comment 1 Ross Burton 2003-03-21 16:58:57 UTC
Created attachment 15154 [details] [review]
API docs patch
Comment 2 Murray Cumming 2003-03-22 20:39:25 UTC
Is this based on the C documentation?

I don't like the mention of reference counting - C++ people shouldn't
care about manual reference counting.

The C++ object is called Glib::Module, or Module, not GModule.

> If nothing can be found, at the moment a valid GModule is
> +   * returned but gobj() will be NULL. This will be fixed in 2.4.
Nobody would expect an invalid C++ instance. That has no meaning. Just
say "check that gobj() != NULL to see whether this succeeded. glibmm
2.4 will have an operator=() for this."

The documentation for the destructor seems to be superfluous. Of
course destructors release memory.,

std::strings can not be NULL. If the C function can take this then we
need to add a method overload without that parameter.
Comment 3 Ross Burton 2003-03-24 13:38:30 UTC
Created attachment 15181 [details] [review]
Updated patch
Comment 4 Murray Cumming 2003-03-24 17:23:50 UTC
So, I think this is based on the C docs?

This should be applied to both branches with the following changes:

s/operation=()/operator bool()/ - sorry, my typo.

Near "It can be an empty string" there should be a "//TODO: " saying
that we should add an override. Actually I suspect that an empty
string != NULL so the documentation might be wrong. If so, we could
fix our implementation to use null if the string is empty. A patch or
TODO for that might be appropriate.

Thanks, Ross.
Comment 5 Ross Burton 2003-03-25 11:36:25 UTC
Created attachment 15197 [details] [review]
Updated patch
Comment 6 Murray Cumming 2003-03-25 14:13:16 UTC
Thanks, Ross, I didn't expect you to provide a revised patch again,
but it's very helpful.

Could someone please apply this, on both branches. We should probably do
s/operation bool/operator bool/ 
though before commiting though.
Comment 7 Murray Cumming 2003-03-26 10:10:33 UTC
Ross, if you have cvs write access, then that means you.
Comment 8 Ross Burton 2003-03-26 13:23:33 UTC
I'm busy too! :)

Committed (with typo fix) to gtkmm2 and glibmm.