brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Remove gtk-doc annotations from the json-glib copy

Browse Source 
There's no need to use gtk-doc annotations: the API is internal to
Clutter.
This commit is contained in:
Emmanuele Bassi 2010-05-20 11:45:54 +01:00
parent 80a8568e0e
commit c75a6b1a1d
5 changed files with 107 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
clutter/json/json-array.c
View File

@ -27,7 +27,7 @@
#include "json-types-private.h"
/**
/*
* SECTION:json-array
* @short_description: a JSON array representation
*
@ -57,7 +57,7 @@ json_array_get_type (void)
return array_type;
}
/**
/*
* json_array_new:
*
* Creates a new #JsonArray.
@ -77,7 +77,7 @@ json_array_new (void)
return array;
}
/**
/*
* json_array_sized_new:
* @n_elements: number of slots to pre-allocate
*
@ -98,7 +98,7 @@ json_array_sized_new (guint n_elements)
return array;
}
/**
/*
* json_array_ref:
* @array: a #JsonArray
*
@ -118,7 +118,7 @@ json_array_ref (JsonArray *array)
return array;
}
/**
/*
* json_array_unref:
* @array: a #JsonArray
*
@ -151,7 +151,7 @@ json_array_unref (JsonArray *array)
}
}
/**
/*
* json_array_get_elements:
* @array: a #JsonArray
*
@ -178,7 +178,7 @@ json_array_get_elements (JsonArray *array)
return g_list_reverse (retval);
}
/**
/*
* json_array_dup_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -207,7 +207,7 @@ json_array_dup_element (JsonArray *array,
return json_node_copy (retval);
}
/**
/*
* json_array_get_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -227,7 +227,7 @@ json_array_get_element (JsonArray *array,
return g_ptr_array_index (array->elements, index_);
}
/**
/*
* json_array_get_int_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -257,7 +257,7 @@ json_array_get_int_element (JsonArray *array,
return json_node_get_int (node);
}
/**
/*
* json_array_get_double_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -287,7 +287,7 @@ json_array_get_double_element (JsonArray *array,
return json_node_get_double (node);
}
/**
/*
* json_array_get_boolean_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -317,7 +317,7 @@ json_array_get_boolean_element (JsonArray *array,
return json_node_get_boolean (node);
}
/**
/*
* json_array_get_string_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -348,7 +348,7 @@ json_array_get_string_element (JsonArray *array,
return json_node_get_string (node);
}
/**
/*
* json_array_get_null_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -376,7 +376,7 @@ json_array_get_null_element (JsonArray *array,
return JSON_NODE_TYPE (node) == JSON_NODE_NULL;
}
/**
/*
* json_array_get_array_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -406,7 +406,7 @@ json_array_get_array_element (JsonArray *array,
return json_node_get_array (node);
}
/**
/*
* json_array_get_object_element:
* @array: a #JsonArray
* @index_: the index of the element to retrieve
@ -436,7 +436,7 @@ json_array_get_object_element (JsonArray *array,
return json_node_get_object (node);
}
/**
/*
* json_array_get_length:
* @array: a #JsonArray
*
@ -452,7 +452,7 @@ json_array_get_length (JsonArray *array)
return array->elements->len;
}
/**
/*
* json_array_add_element:
* @array: a #JsonArray
* @node: a #JsonNode
@ -470,7 +470,7 @@ json_array_add_element (JsonArray *array,
g_ptr_array_add (array->elements, node);
}
/**
/*
* json_array_add_int_element:
* @array: a #JsonArray
* @value: an integer value
@ -495,7 +495,7 @@ json_array_add_int_element (JsonArray *array,
g_ptr_array_add (array->elements, node);
}
/**
/*
* json_array_add_double_element:
* @array: a #JsonArray
* @value: a floating point value
@ -520,7 +520,7 @@ json_array_add_double_element (JsonArray *array,
g_ptr_array_add (array->elements, node);
}
/**
/*
* json_array_add_boolean_element:
* @array: a #JsonArray
* @value: a boolean value
@ -545,7 +545,7 @@ json_array_add_boolean_element (JsonArray *array,
g_ptr_array_add (array->elements, node);
}
/**
/*
* json_array_add_string_element:
* @array: a #JsonArray
* @value: a string value
@ -571,7 +571,7 @@ json_array_add_string_element (JsonArray *array,
g_ptr_array_add (array->elements, node);
}
/**
/*
* json_array_add_null_element:
* @array: a #JsonArray
*
@ -593,7 +593,7 @@ json_array_add_null_element (JsonArray *array)
g_ptr_array_add (array->elements, node);
}
/**
/*
* json_array_add_array_element:
* @array: a #JsonArray
* @value: a #JsonArray
@ -620,7 +620,7 @@ json_array_add_array_element (JsonArray *array,
g_ptr_array_add (array->elements, node);
}
/**
/*
* json_array_add_object_element:
* @array: a #JsonArray
* @value: a #JsonObject
@ -647,7 +647,7 @@ json_array_add_object_element (JsonArray *array,
g_ptr_array_add (array->elements, node);
}
/**
/*
* json_array_remove_element:
* @array: a #JsonArray
* @index_: the position of the element to be removed
@ -665,7 +665,7 @@ json_array_remove_element (JsonArray *array,
json_node_free (g_ptr_array_remove_index (array->elements, index_));
}
/**
/*
* json_array_foreach_element:
* @array: a #JsonArray
* @func: the function to be called on each element

18
clutter/json/json-generator.c
View File

@ -21,7 +21,7 @@
* Emmanuele Bassi <ebassi@linux.intel.com>
*/
/**
/*
* SECTION:json-generator
* @short_description: Generates JSON data streams
*
@ -191,7 +191,7 @@ json_generator_class_init (JsonGeneratorClass *klass)
gobject_class->get_property = json_generator_get_property;
gobject_class->finalize = json_generator_finalize;
/**
/*
* JsonGenerator:pretty:
*
* Whether the output should be "pretty-printed", with indentation and
@ -205,7 +205,7 @@ json_generator_class_init (JsonGeneratorClass *klass)
"Pretty-print the output",
FALSE,
G_PARAM_READWRITE));
/**
/*
* JsonGenerator:indent:
*
* Number of spaces to be used to indent when pretty printing.
@ -218,7 +218,7 @@ json_generator_class_init (JsonGeneratorClass *klass)
0, G_MAXUINT,
2,
G_PARAM_READWRITE));
/**
/*
* JsonGenerator:root:
*
* The root #JsonNode to be used when constructing a JSON data
@ -233,7 +233,7 @@ json_generator_class_init (JsonGeneratorClass *klass)
"Root of the JSON data tree",
JSON_TYPE_NODE,
G_PARAM_READWRITE));
/**
/*
* JsonGenerator:indent-char:
*
* The character that should be used when indenting in pretty print.
@ -519,7 +519,7 @@ dump_object (JsonGenerator *generator,
return g_string_free (buffer, FALSE);
}
/**
/*
* json_generator_new:
*
* Creates a new #JsonGenerator. You can use this object to generate a
@ -534,7 +534,7 @@ json_generator_new (void)
return g_object_new (JSON_TYPE_GENERATOR, NULL);
}
/**
/*
* json_generator_to_data:
* @generator: a #JsonGenerator
* @length: (out): return location for the length of the returned
@ -588,7 +588,7 @@ json_generator_to_data (JsonGenerator *generator,
return retval;
}
/**
/*
* json_generator_to_file:
* @generator: a #JsonGenerator
* @filename: path to the target file
@ -618,7 +618,7 @@ json_generator_to_file (JsonGenerator *generator,
return retval;
}
/**
/*
* json_generator_set_root:
* @generator: a #JsonGenerator
* @node: a #JsonNode

56
clutter/json/json-node.c
View File

@ -29,7 +29,7 @@
#include "json-types-private.h"
/**
/*
* SECTION:json-node
* @short_description: Node in a JSON object model
*
@ -61,7 +61,7 @@ json_node_get_type (void)
return node_type;
}
/**
/*
* json_node_get_value_type:
* @node: a #JsonNode
*
@ -96,7 +96,7 @@ json_node_get_value_type (JsonNode *node)
}
}
/**
/*
* json_node_new:
* @type: a #JsonNodeType
*
@ -118,7 +118,7 @@ json_node_new (JsonNodeType type)
return data;
}
/**
/*
* json_node_copy:
* @node: a #JsonNode
*
@ -167,7 +167,7 @@ json_node_copy (JsonNode *node)
return copy;
}
/**
/*
* json_node_set_object:
* @node: a #JsonNode
* @object: a #JsonObject
@ -190,7 +190,7 @@ json_node_set_object (JsonNode *node,
node->data.object = NULL;
}
/**
/*
* json_node_take_object:
* @node: a #JsonNode
* @object: a #JsonObject
@ -214,7 +214,7 @@ json_node_take_object (JsonNode *node,
node->data.object = object;
}
/**
/*
* json_node_get_object:
* @node: a #JsonNode
*
@ -231,7 +231,7 @@ json_node_get_object (JsonNode *node)
return node->data.object;
}
/**
/*
* json_node_dup_object:
* @node: a #JsonNode
*
@ -252,7 +252,7 @@ json_node_dup_object (JsonNode *node)
return NULL;
}
/**
/*
* json_node_set_array:
* @node: a #JsonNode
* @array: a #JsonArray
@ -275,7 +275,7 @@ json_node_set_array (JsonNode *node,
node->data.array = NULL;
}
/**
/*
* json_node_take_array:
* @node: a #JsonNode
* @array: a #JsonArray
@ -299,7 +299,7 @@ json_node_take_array (JsonNode *node,
node->data.array = array;
}
/**
/*
* json_node_get_array:
* @node: a #JsonNode
*
@ -316,7 +316,7 @@ json_node_get_array (JsonNode *node)
return node->data.array;
}
/**
/*
* json_node_dup_array
* @node: a #JsonNode
*
@ -337,7 +337,7 @@ json_node_dup_array (JsonNode *node)
return NULL;
}
/**
/*
* json_node_get_value:
* @node: a #JsonNode
* @value: return location for an uninitialized value
@ -366,7 +366,7 @@ node_value_unset (JsonNode *node)
g_value_unset (&(node->data.value));
}
/**
/*
* json_node_set_value:
* @node: a #JsonNode
* @value: the #GValue to set
@ -417,7 +417,7 @@ json_node_set_value (JsonNode *node,
}
/**
/*
* json_node_free:
* @node: a #JsonNode
*
@ -452,7 +452,7 @@ json_node_free (JsonNode *node)
}
}
/**
/*
* json_node_type_name:
* @node: a #JsonNode
*
@ -484,7 +484,7 @@ json_node_type_name (JsonNode *node)
return "unknown";
}
/**
/*
* json_node_get_parent:
* @node: a #JsonNode
*
@ -500,7 +500,7 @@ json_node_get_parent (JsonNode *node)
return node->parent;
}
/**
/*
* json_node_set_string:
* @node: a #JsonNode of type %JSON_NODE_VALUE
* @value: a string value
@ -530,7 +530,7 @@ json_node_set_string (JsonNode *node,
}
}
/**
/*
* json_node_get_string:
* @node: a #JsonNode of type %JSON_NODE_VALUE
*
@ -552,7 +552,7 @@ json_node_get_string (JsonNode *node)
return NULL;
}
/**
/*
* json_node_dup_string:
* @node: a #JsonNode of type %JSON_NODE_VALUE
*
@ -575,7 +575,7 @@ json_node_dup_string (JsonNode *node)
return NULL;
}
/**
/*
* json_node_set_int:
* @node: a #JsonNode of type %JSON_NODE_VALUE
* @value: an integer value
@ -605,7 +605,7 @@ json_node_set_int (JsonNode *node,
}
}
/**
/*
* json_node_get_int:
* @node: a #JsonNode of type %JSON_NODE_VALUE
*
@ -627,7 +627,7 @@ json_node_get_int (JsonNode *node)
return 0;
}
/**
/*
* json_node_set_double:
* @node: a #JsonNode of type %JSON_NODE_VALUE
* @value: a double value
@ -657,7 +657,7 @@ json_node_set_double (JsonNode *node,
}
}
/**
/*
* json_node_get_double:
* @node: a #JsonNode of type %JSON_NODE_VALUE
*
@ -679,7 +679,7 @@ json_node_get_double (JsonNode *node)
return 0.0;
}
/**
/*
* json_node_set_boolean:
* @node: a #JsonNode of type %JSON_NODE_VALUE
* @value: a boolean value
@ -709,7 +709,7 @@ json_node_set_boolean (JsonNode *node,
}
}
/**
/*
* json_node_get_boolean:
* @node: a #JsonNode of type %JSON_NODE_VALUE
*
@ -731,7 +731,7 @@ json_node_get_boolean (JsonNode *node)
return FALSE;
}
/**
/*
* json_node_get_node_type:
* @node: a #JsonNode
*
@ -749,7 +749,7 @@ json_node_get_node_type (JsonNode *node)
return node->type;
}
/**
/*
* json_node_is_null:
* @node: a #JsonNode
*

56
clutter/json/json-object.c
View File

@ -29,7 +29,7 @@
#include "json-types-private.h"
/**
/*
* SECTION:json-object
* @short_description: a JSON object representation
*
@ -64,7 +64,7 @@ json_object_get_type (void)
return object_type;
}
/**
/*
* json_object_new:
*
* Creates a new #JsonObject, an JSON object type representation.
@ -86,7 +86,7 @@ json_object_new (void)
return object;
}
/**
/*
* json_object_ref:
* @object: a #JsonObject
*
@ -106,7 +106,7 @@ json_object_ref (JsonObject *object)
return object;
}
/**
/*
* json_object_unref:
* @object: a #JsonObject
*
@ -144,7 +144,7 @@ object_set_member_internal (JsonObject *object,
node);
}
/**
/*
* json_object_add_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -178,7 +178,7 @@ json_object_add_member (JsonObject *object,
object_set_member_internal (object, member_name, node);
}
/**
/*
* json_object_set_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -204,7 +204,7 @@ json_object_set_member (JsonObject *object,
object_set_member_internal (object, member_name, node);
}
/**
/*
* json_object_set_int_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -232,7 +232,7 @@ json_object_set_int_member (JsonObject *object,
object_set_member_internal (object, member_name, node);
}
/**
/*
* json_object_set_double_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -260,7 +260,7 @@ json_object_set_double_member (JsonObject *object,
object_set_member_internal (object, member_name, node);
}
/**
/*
* json_object_set_boolean_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -288,7 +288,7 @@ json_object_set_boolean_member (JsonObject *object,
object_set_member_internal (object, member_name, node);
}
/**
/*
* json_object_set_string_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -316,7 +316,7 @@ json_object_set_string_member (JsonObject *object,
object_set_member_internal (object, member_name, node);
}
/**
/*
* json_object_set_null_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -341,7 +341,7 @@ json_object_set_null_member (JsonObject *object,
object_set_member_internal (object, member_name, node);
}
/**
/*
* json_object_set_array_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -371,7 +371,7 @@ json_object_set_array_member (JsonObject *object,
object_set_member_internal (object, member_name, node);
}
/**
/*
* json_object_set_object_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -448,7 +448,7 @@ g_hash_table_get_values (GHashTable *hash_table)
}
#endif /* GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION < 14 */
/**
/*
* json_object_get_members:
* @object: a #JsonObject
*
@ -468,7 +468,7 @@ json_object_get_members (JsonObject *object)
return g_hash_table_get_keys (object->members);
}
/**
/*
* json_object_get_values:
* @object: a #JsonObject
*
@ -487,7 +487,7 @@ json_object_get_values (JsonObject *object)
return g_hash_table_get_values (object->members);
}
/**
/*
* json_object_dup_member:
* @object: a #JsonObject
* @member_name: the name of the JSON object member to access
@ -523,7 +523,7 @@ object_get_member_internal (JsonObject *object,
return g_hash_table_lookup (object->members, member_name);
}
/**
/*
* json_object_get_member:
* @object: a #JsonObject
* @member_name: the name of the JSON object member to access
@ -544,7 +544,7 @@ json_object_get_member (JsonObject *object,
return object_get_member_internal (object, member_name);
}
/**
/*
* json_object_get_int_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -574,7 +574,7 @@ json_object_get_int_member (JsonObject *object,
return json_node_get_int (node);
}
/**
/*
* json_object_get_double_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -604,7 +604,7 @@ json_object_get_double_member (JsonObject *object,
return json_node_get_double (node);
}
/**
/*
* json_object_get_boolean_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -634,7 +634,7 @@ json_object_get_boolean_member (JsonObject *object,
return json_node_get_boolean (node);
}
/**
/*
* json_object_get_null_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -663,7 +663,7 @@ json_object_get_null_member (JsonObject *object,
return JSON_NODE_TYPE (node) == JSON_NODE_NULL;
}
/**
/*
* json_object_get_string_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -693,7 +693,7 @@ json_object_get_string_member (JsonObject *object,
return json_node_get_string (node);
}
/**
/*
* json_object_get_array_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -723,7 +723,7 @@ json_object_get_array_member (JsonObject *object,
return json_node_get_array (node);
}
/**
/*
* json_object_get_object_member:
* @object: a #JsonObject
* @member_name: the name of the member
@ -753,7 +753,7 @@ json_object_get_object_member (JsonObject *object,
return json_node_get_object (node);
}
/**
/*
* json_object_has_member:
* @object: a #JsonObject
* @member_name: the name of a JSON object member
@ -772,7 +772,7 @@ json_object_has_member (JsonObject *object,
return (g_hash_table_lookup (object->members, member_name) != NULL);
}
/**
/*
* json_object_get_size:
* @object: a #JsonObject
*
@ -788,7 +788,7 @@ json_object_get_size (JsonObject *object)
return g_hash_table_size (object->members);
}
/**
/*
* json_object_remove_member:
* @object: a #JsonObject
* @member_name: the name of the member to remove
@ -827,7 +827,7 @@ json_object_foreach_internal (gpointer key,
clos->func (clos->object, member_name, member_node, clos->data);
}
/**
/*
* json_object_foreach_member:
* @object: a #JsonObject
* @func: the function to be called on each member

32
clutter/json/json-parser.c
View File

@ -17,7 +17,7 @@
* Emmanuele Bassi <ebassi@openedhand.com>
*/
/**
/*
* SECTION:json-parser
* @short_description: Parse JSON data streams
*
@ -167,7 +167,7 @@ json_parser_class_init (JsonParserClass *klass)
gobject_class->dispose = json_parser_dispose;
/**
/*
* JsonParser::parse-start:
* @parser: the #JsonParser that received the signal
*
@ -182,7 +182,7 @@ json_parser_class_init (JsonParserClass *klass)
NULL, NULL,
_json_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
/*
* JsonParser::parse-end:
* @parser: the #JsonParser that received the signal
*
@ -197,7 +197,7 @@ json_parser_class_init (JsonParserClass *klass)
NULL, NULL,
_json_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
/*
* JsonParser::object-start:
* @parser: the #JsonParser that received the signal
*
@ -212,7 +212,7 @@ json_parser_class_init (JsonParserClass *klass)
NULL, NULL,
_json_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
/*
* JsonParser::object-member:
* @parser: the #JsonParser that received the signal
* @object: a #JsonObject
@ -232,7 +232,7 @@ json_parser_class_init (JsonParserClass *klass)
G_TYPE_NONE, 2,
JSON_TYPE_OBJECT,
G_TYPE_STRING);
/**
/*
* JsonParser::object-end:
* @parser: the #JsonParser that received the signal
* @object: the parsed #JsonObject
@ -249,7 +249,7 @@ json_parser_class_init (JsonParserClass *klass)
_json_marshal_VOID__BOXED,
G_TYPE_NONE, 1,
JSON_TYPE_OBJECT);
/**
/*
* JsonParser::array-start:
* @parser: the #JsonParser that received the signal
*
@ -264,7 +264,7 @@ json_parser_class_init (JsonParserClass *klass)
NULL, NULL,
_json_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
/*
* JsonParser::array-element:
* @parser: the #JsonParser that received the signal
* @array: a #JsonArray
@ -284,7 +284,7 @@ json_parser_class_init (JsonParserClass *klass)
G_TYPE_NONE, 2,
JSON_TYPE_ARRAY,
G_TYPE_INT);
/**
/*
* JsonParser::array-end:
* @parser: the #JsonParser that received the signal
* @array: the parsed #JsonArrary
@ -301,7 +301,7 @@ json_parser_class_init (JsonParserClass *klass)
_json_marshal_VOID__BOXED,
G_TYPE_NONE, 1,
JSON_TYPE_ARRAY);
/**
/*
* JsonParser::error:
* @parser: the parser instance that received the signal
* @error: a pointer to the #GError
@ -885,7 +885,7 @@ json_scanner_new (JsonParser *parser)
return scanner;
}
/**
/*
* json_parser_new:
*
* Creates a new #JsonParser instance. You can use the #JsonParser to
@ -901,7 +901,7 @@ json_parser_new (void)
return g_object_new (JSON_TYPE_PARSER, NULL);
}
/**
/*
* json_parser_load_from_file:
* @parser: a #JsonParser
* @filename: the path for the file to parse
@ -944,7 +944,7 @@ json_parser_load_from_file (JsonParser *parser,
return retval;
}
/**
/*
* json_parser_load_from_data:
* @parser: a #JsonParser
* @data: the buffer to parse
@ -1067,7 +1067,7 @@ json_parser_load_from_data (JsonParser *parser,
return retval;
}
/**
/*
* json_parser_get_root:
* @parser: a #JsonParser
*
@ -1084,7 +1084,7 @@ json_parser_get_root (JsonParser *parser)
return parser->priv->root;
}
/**
/*
* json_parser_get_current_line:
* @parser: a #JsonParser
*
@ -1103,7 +1103,7 @@ json_parser_get_current_line (JsonParser *parser)
return 0;
}
/**
/*
* json_parser_get_current_pos:
* @parser: a #JsonParser
*