luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-20 15:48:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation around deprecations

Browse Source
This commit is contained in:
Matthias Clasen
2012-02-27 00:18:47 -05:00
parent 550fcaddf7
commit 76175ab9ed
5 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/glib/Makefile.am
View File

@@ -64,7 +64,6 @@ content_files = \
running.sgml \ running.sgml \
building.sgml \ building.sgml \
changes.sgml \ changes.sgml \
compiling.sgml \
resources.sgml \ resources.sgml \
regex-syntax.sgml \ regex-syntax.sgml \
version.xml \ version.xml \
@@ -74,6 +73,9 @@ content_files = \
gvariant-varargs.xml \ gvariant-varargs.xml \
gvariant-text.xml gvariant-text.xml
expand_content_files = \
compiling.sgml
# Extra options to supply to gtkdoc-fixref # Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../gobject/html --extra-dir=$(srcdir)/../gio/html FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../gobject/html --extra-dir=$(srcdir)/../gio/html

2
docs/reference/glib/compiling.sgml
View File

@@ -75,7 +75,7 @@ Deprecated GLib functions are annotated to make the compiler
emit warnings when they are used (e.g. with gcc, you need to use emit warnings when they are used (e.g. with gcc, you need to use
the -Wdeprecated-declarations option). If these warnings are the -Wdeprecated-declarations option). If these warnings are
problematic, they can be turned off by defining the preprocessor problematic, they can be turned off by defining the preprocessor
symbol GLIB_DISABLE_DEPRECATION_WARNINGS by using the commandline symbol %GLIB_DISABLE_DEPRECATION_WARNINGS by using the commandline
option <literal>-DGLIB_DISABLE_DEPRECATION_WARNINGS</literal> option <literal>-DGLIB_DISABLE_DEPRECATION_WARNINGS</literal>
</para> </para>

2
docs/reference/glib/glib-docs.sgml
View File

@@ -32,7 +32,7 @@
<xi:include href="building.sgml" /> <xi:include href="building.sgml" />
<xi:include href="cross.sgml" /> <xi:include href="cross.sgml" />
<xi:include href="compiling.sgml" /> <xi:include href="xml/compiling.sgml" />
<xi:include href="running.sgml" /> <xi:include href="running.sgml" />
<xi:include href="changes.sgml" /> <xi:include href="changes.sgml" />
<xi:include href="resources.sgml" /> <xi:include href="resources.sgml" />

1
docs/reference/glib/glib-sections.txt
View File

@@ -120,6 +120,7 @@ GLIB_VERSION_2_30
GLIB_VERSION_2_32 GLIB_VERSION_2_32
GLIB_VERSION_MIN_REQUIRED GLIB_VERSION_MIN_REQUIRED
GLIB_VERSION_MAX_ALLOWED GLIB_VERSION_MAX_ALLOWED
GLIB_DISABLE_DEPRECATION_WARNINGS
</SECTION> </SECTION>
<SECTION> <SECTION>

8
glib/docs.c
View File

@@ -2051,6 +2051,14 @@
* Since: 2.32 * Since: 2.32
*/ */
/**
* GLIB_DISABLE_DEPRECATION_WARNINGS:
*
* A macro that should be defined before including the glib.h header.
* If it is defined, no compiler warnings will be produced for uses
* of deprecated GLib APIs.
*/
/** /**
* G_GNUC_NORETURN: * G_GNUC_NORETURN:
* *