gtkenums: correct various documentation typos

[~andy/gtk] / gtk / gtkappchooser.c

diff --git a/gtk/gtkappchooser.c b/gtk/gtkappchooser.c
index 1e8843a1ff71adc92f4a8c8f8b12ff46b7e29757..e4037d2c1e0fde5e9772b19c2218012dfa36c2e1 100644 (file)
--- a/gtk/gtkappchooser.c
+++ b/gtk/gtkappchooser.c
@@ -14,13 +14,36 @@
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public
- * License along with the Gnome Library; see the file COPYING.LIB.  If not,
- * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  *
  * Authors: Cosimo Cecchi <ccecchi@redhat.com>
  */
 
+/**
+ * SECTION:gtkappchooser
+ * @Title: GtkAppChooser
+ * @Short_description: Interface implemented by widgets for choosing an application
+ * @See_also: #GAppInfo
+ *
+ * #GtkAppChooser is an interface that can be implemented by widgets which
+ * allow the user to choose an application (typically for the purpose of
+ * opening a file). The main objects that implement this interface are
+ * #GtkAppChooserWidget, #GtkAppChooserDialog and #GtkAppChooserButton.
+ *
+ * Applications are represented by GIO #GAppInfo objects here.
+ * GIO has a concept of recommended and fallback applications for a
+ * given content type. Recommended applications are those that claim
+ * to handle the content type itself, while fallback also includes
+ * applications that handle a more generic content type. GIO also
+ * knows the default and last-used application for a given content
+ * type. The #GtkAppChooserWidget provides detailed control over
+ * whether the shown list of applications should include default,
+ * recommended or fallback applications.
+ *
+ * To obtain the application that has been selected in a #GtkAppChooser,
+ * use gtk_app_chooser_get_app_info().
+ */
+
 #include "config.h"
 
 #include "gtkappchooser.h"
@@ -38,6 +61,14 @@ gtk_app_chooser_default_init (GtkAppChooserIface *iface)
 {
   GParamSpec *pspec;
 
+  /**
+   * GtkAppChooser:content-type:
+   *
+   * The content type of the #GtkAppChooser object.
+   *
+   * See <link linkend="gio-GContentType"><type>GContentType</type></link>
+   * for more information about content types.
+   */
   pspec = g_param_spec_string ("content-type",
                                P_("Content type"),
                                P_("The content type used by the open with object"),
@@ -47,6 +78,17 @@ gtk_app_chooser_default_init (GtkAppChooserIface *iface)
   g_object_interface_install_property (iface, pspec);
 }
 
+
+/**
+ * gtk_app_chooser_get_content_type:
+ * @self: a #GtkAppChooser
+ *
+ * Returns the current value of the #GtkAppChooser:content-type property.
+ *
+ * Returns: the content type of @self. Free with g_free()
+ *
+ * Since: 3.0
+ */
 gchar *
 gtk_app_chooser_get_content_type (GtkAppChooser *self)
 {
@@ -68,7 +110,7 @@ gtk_app_chooser_get_content_type (GtkAppChooser *self)
  * Returns the currently selected application.
  *
  * Returns: (transfer full): a #GAppInfo for the currently selected
- *     application, or %NULL if none is selected. Free with g_object_unref().
+ *     application, or %NULL if none is selected. Free with g_object_unref()
  *
  * Since: 3.0
  */
@@ -82,7 +124,7 @@ gtk_app_chooser_get_app_info (GtkAppChooser *self)
  * gtk_app_chooser_refresh:
  * @self: a #GtkAppChooser
  *
- * Reload the list of applications.
+ * Reloads the list of applications.
  *
  * Since: 3.0
  */