summaryrefslogtreecommitdiff
path: root/glib/docs.c
Commit message (Collapse)AuthorAgeFilesLines
* G_GNUC_FORMAT: documentation errorSimon Kågedal Reimer2013-05-231-1/+1
| | | | | | | Attribute should be placed just before the semicolon, not after. As can be seen in the example. https://bugzilla.gnome.org/show_bug.cgi?id=699779
* docs: Improve G_GNUC_* documentationDavid King2012-08-161-17/+77
| | | | | | | Mention where the GCC attributes should be placed for functions and arguments. Add an example for G_GNUC_UNUSED. https://bugzilla.gnome.org/show_bug.cgi?id=326931
* glib/: gtk-doc cleanupRyan Lortie2012-06-251-0/+3
|
* Improve documentation around deprecationsMatthias Clasen2012-02-271-0/+8
|
* Add flexible API version boundariesEmmanuele Bassi2012-02-261-0/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are cases when it should be possible to define at compile time what range of functions and types should be used, in order to get, or restrict, the compiler warnings for deprecated or newly added types or functions. For instance, if GLib introduces a deprecation warning on a type in version 2.32, application code can decide to specify the minimum and maximum boundary of the used API to be 2.30; when compiling against a new version of GLib, this would produce the following results: - all deprecations introduced prior to 2.32 would emit compiler warnings when used by the application code; - all deprecations introduced in 2.32 would not emit compiler warnings when used by the application code; - all new symbols introduced in 2.32 would emit a compiler warning. Using this scheme it should be possible to have fairly complex situations, like the following one: assuming that an application is compiled with: GLIB_VERSION_MIN_REQUIRED = GLIB_VERSION_2_30 GLIB_VERSION_MAX_ALLOWED = GLIB_VERSION_2_32 and a GLib header containing: void function_A (void) GLIB_DEPRECATED_IN_2_26; void function_B (void) GLIB_DEPRECATED_IN_2_28; void function_C (void) GLIB_DEPRECATED_IN_2_30; void function_D (void) GLIB_AVAILABLE_IN_2_32; void function_E (void) GLIB_AVAILABLE_IN_2_34; any application code using the above functions will get the following compiler warnings: function_A: deprecated symbol warning function_B: deprecated symbol warning function_C: no warning function_D: no warning function_E: undefined symbol warning This means that it should be possible to gradually port code towards non-deprecated API gradually, on a per-release basis. https://bugzilla.gnome.org/show_bug.cgi?id=670542
* Add G_GNUC_BEGIN/END_IGNORE_DEPRECATIONSDan Winship2012-02-151-0/+33
| | | | | | | | | Add new macros to disable -Wdeprecated-declarations around a piece of code, using the C99 (and GNU89) _Pragma() operator. Replace the existing use of #pragma for this in gio, and suppress the warnings in gvaluearray.c as well. https://bugzilla.gnome.org/show_bug.cgi?id=669671
* documentation fixesStef Walter2011-12-131-2/+4
| | | | | | | | Fixes for gtk-doc warnings. http://bugzilla.gnome.org/show_bug.cgi?id=66469 https://bugzilla.gnome.org/show_bug.cgi?id=664699
* Move remaining docs inlineMatthias Clasen2011-11-141-0/+2259
This introduces a fake source file just for holding docs that have no good place elsewhere. Not great, but better than templates.