From 9874fe3c400f16bbe6769899702a343da525e1d6 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Fri, 16 Jan 2015 09:43:16 +0000 Subject: [PATCH] gobject: Cross-link from GType reference docs to GType conventions page Make it a little easier to find the GType conventions page, which I guess should be the canonical guide to how to name things. This adds a brief mention of the valid characters in a type name to the conventions page. https://bugzilla.gnome.org/show_bug.cgi?id=743018 --- docs/reference/gobject/tut_gtype.xml | 4 ++++ gobject/gtype.c | 8 ++++---- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/reference/gobject/tut_gtype.xml b/docs/reference/gobject/tut_gtype.xml index f6d529eb4..2acc26311 100644 --- a/docs/reference/gobject/tut_gtype.xml +++ b/docs/reference/gobject/tut_gtype.xml @@ -232,6 +232,10 @@ struct _GTypeValueTable There are a number of conventions users are expected to follow when creating new types which are to be exported in a header file: + + Type names (including object names) must be at least three + characters long and start with ‘a–z’, ‘A–Z’ or ‘_’. + Use the object_method pattern for function names: to invoke the method named foo on an instance of object type bar, call diff --git a/gobject/gtype.c b/gobject/gtype.c index 4e6f77d89..990002b3b 100644 --- a/gobject/gtype.c +++ b/gobject/gtype.c @@ -76,10 +76,10 @@ * separately (typically by using #GArray or #GPtrArray) and put a pointer * to the buffer in the structure. * - * A final word about type names: Such an identifier needs to be at least - * three characters long. There is no upper length limit. The first character - * needs to be a letter (a-z or A-Z) or an underscore '_'. Subsequent - * characters can be letters, numbers or any of '-_+'. + * As mentioned in the [GType conventions][gtype-conventions], type names must + * be at least three characters long. There is no upper length limit. The first + * character must be a letter (a–z or A–Z) or an underscore (‘_’). Subsequent + * characters can be letters, numbers or any of ‘-_+’. */