libs/glibmm2/glib/src/glib_docs_override.xml

   1 <root>
   2     <function name="g_option_context_set_summary">
   3         <description>
   4             Adds a string to be displayed in --help output before the list of options. This
   5             is typically a summary of the program functionality.
   6
   7             Note that the summary is translated (see set_translate_func(),
   8             set_translation_domain()).
   9
  10             Since: 2.14
  11
  12         </description>
  13         <parameters>
  14             <parameter name="summary">
  15                 <parameter_description> a string to be shown in --help output before the list of
  16                     options
  17                 </parameter_description>
  18             </parameter>
  19         </parameters>
  20         <return></return>
  21     </function>
  22
  23     <function name="g_option_context_get_summary">
  24         <description>
  25             Returns: the summary
  26             See set_summary() for more information
  27
  28         </description>
  29         <parameters>
  30         </parameters>
  31         <return> the summary
  32
  33             Since: 2.14
  34         </return>
  35     </function>
  36
  37     <function name="g_option_context_set_description">
  38         <description>
  39             Adds a string to be displayed in --help output after the list of
  40             options. This text often includes a bug reporting address.
  41
  42             Note that the summary is translated (see set_translate_func()).
  43
  44             Since: 2.14
  45
  46         </description>
  47         <parameters>
  48             <parameter name="description">
  49                 <parameter_description> a string to be shown in --help output
  50                     after the list of options
  51                 </parameter_description>
  52             </parameter>
  53         </parameters>
  54         <return></return>
  55     </function>
  56
  57     <function name="g_option_context_get_description">
  58         <description>
  59             Returns: the description
  60             See set_description() for more information
  61
  62         </description>
  63         <parameters>
  64         </parameters>
  65         <return> the description
  66
  67             Since: 2.14
  68         </return>
  69     </function>
  70
  71     <function name="g_option_context_set_translation_domain">
  72         <description>
  73             A convenience function to use gettext() for translating
  74             user-visible strings.
  75
  76             Since: 2.14
  77
  78         </description>
  79         <parameters>
  80             <parameter name="domain">
  81                 <parameter_description> the domain to use
  82                 </parameter_description>
  83             </parameter>
  84         </parameters>
  85         <return></return>
  86     </function>
  87
  88
  89 <function name="g_key_file_get_double">
  90 <description>
  91 Return value: the value associated with the key as a double, or
  92
  93 </description>
  94 <parameters>
  95 <parameter name="key_file">
  96 <parameter_description> a #GKeyFile
  97 </parameter_description>
  98 </parameter>
  99 <parameter name="group_name">
 100 <parameter_description> a group name
 101 </parameter_description>
 102 </parameter>
 103 <parameter name="key">
 104 <parameter_description> a key
 105 </parameter_description>
 106 </parameter>
 107 <parameter name="error">
 108 <parameter_description> return location for a #GError
 109 </parameter_description>
 110 </parameter>
 111 </parameters>
 112 <return> the value associated with the key as a double, or
 113 0.0 if the key was not found or could not be parsed.
 114
 115 Since: 2.14
 116 </return>
 117 </function>
 118
 119
 120 <function name="g_key_file_set_double">
 121 <description>
 122 Associates a new double value with @key under @group_name.
 123 If @key cannot be found then it is created.
 124
 125 Since: 2.14
 126
 127 </description>
 128 <parameters>
 129 <parameter name="key_file">
 130 <parameter_description> a #GKeyFile
 131 </parameter_description>
 132 </parameter>
 133 <parameter name="group_name">
 134 <parameter_description> a group name
 135 </parameter_description>
 136 </parameter>
 137 <parameter name="key">
 138 <parameter_description> a key
 139 </parameter_description>
 140 </parameter>
 141 <parameter name="value">
 142 <parameter_description> an double value
 143 </parameter_description>
 144 </parameter>
 145 </parameters>
 146 <return></return>
 147 </function>
 148
 149
 150 </root>
 151