fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-05-03 13:38:01 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Hide private docs

Browse source 
If a private symbol gets a docblock stanza, gtk-doc becomes *very*
confused.
This commit is contained in:
Emmanuele Bassi 2023-09-23 13:11:46 +01:00
parent d2790e2b1a
commit 7c5d0de2d2
1 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
src/cairo-array.c
View file

@ -40,7 +40,7 @@
#include "cairo-array-private.h"
#include "cairo-error-private.h"
/**
/*< private >
* _cairo_array_init:
*
* Initialize a new #cairo_array_t object to store objects each of size
@ -63,7 +63,7 @@ _cairo_array_init (cairo_array_t *array, unsigned int element_size)
array->elements = NULL;
}
/**
/*< private >
* _cairo_array_fini:
* @array: A #cairo_array_t
*
@ -77,7 +77,7 @@ _cairo_array_fini (cairo_array_t *array)
free (array->elements);
}
/**
/*< private >
* _cairo_array_grow_by:
* @array: a #cairo_array_t
*
@ -125,7 +125,7 @@ _cairo_array_grow_by (cairo_array_t *array, unsigned int additional)
return CAIRO_STATUS_SUCCESS;
}
/**
/*< private >
* _cairo_array_truncate:
* @array: a #cairo_array_t
*
@ -140,7 +140,7 @@ _cairo_array_truncate (cairo_array_t *array, unsigned int num_elements)
array->num_elements = num_elements;
}
/**
/*< private >
* _cairo_array_index:
* @array: a #cairo_array_t
*
@ -149,7 +149,7 @@ _cairo_array_truncate (cairo_array_t *array, unsigned int num_elements)
* pointer may be used for further direct indexing with []. For
* example:
*
* <informalexample><programlisting>
* |[<!-- language="C" -->
* cairo_array_t array;
* double *values;
*
@ -159,7 +159,7 @@ _cairo_array_truncate (cairo_array_t *array, unsigned int num_elements)
* values = _cairo_array_index (&array, 0);
* for (i = 0; i < _cairo_array_num_elements (&array); i++)
* ... use values[i] here ...
* </programlisting></informalexample>
* ]|
*
* Returns: A pointer to the object stored at @index.
**/
@ -185,7 +185,7 @@ _cairo_array_index (cairo_array_t *array, unsigned int index)
return array->elements + (size_t)index * array->element_size;
}
/**
/*< private >
* _cairo_array_index_const:
* @array: a #cairo_array_t
*
@ -194,7 +194,7 @@ _cairo_array_index (cairo_array_t *array, unsigned int index)
* pointer may be used for further direct indexing with []. For
* example:
*
* <informalexample><programlisting>
* |[<!-- language="C" --.
* cairo_array_t array;
* const double *values;
*
@ -204,7 +204,7 @@ _cairo_array_index (cairo_array_t *array, unsigned int index)
* values = _cairo_array_index_const (&array, 0);
* for (i = 0; i < _cairo_array_num_elements (&array); i++)
* ... read values[i] here ...
* </programlisting></informalexample>
* ]|
*
* Returns: A pointer to the object stored at @index.
**/
@ -230,7 +230,7 @@ _cairo_array_index_const (const cairo_array_t *array, unsigned int index)
return array->elements + (size_t)index * array->element_size;
}
/**
/*< private >
* _cairo_array_copy_element:
* @array: a #cairo_array_t
*
@ -245,7 +245,7 @@ _cairo_array_copy_element (const cairo_array_t *array,
memcpy (dst, _cairo_array_index_const (array, index), array->element_size);
}
/**
/*< private >
* _cairo_array_append:
* @array: a #cairo_array_t
*
@ -267,7 +267,7 @@ _cairo_array_append (cairo_array_t *array,
return _cairo_array_append_multiple (array, element, 1);
}
/**
/*< private >
* _cairo_array_append_multiple:
* @array: a #cairo_array_t
*
@ -296,7 +296,7 @@ _cairo_array_append_multiple (cairo_array_t *array,
return CAIRO_STATUS_SUCCESS;
}
/**
/*< private >
* _cairo_array_allocate:
* @array: a #cairo_array_t
*
@ -329,7 +329,7 @@ _cairo_array_allocate (cairo_array_t *array,
return CAIRO_STATUS_SUCCESS;
}
/**
/*< private >
* _cairo_array_num_elements:
* @array: a #cairo_array_t
*
@ -343,7 +343,7 @@ _cairo_array_num_elements (const cairo_array_t *array)
return array->num_elements;
}
/**
/*< private >
* _cairo_array_size:
* @array: a #cairo_array_t
*
@ -358,7 +358,7 @@ _cairo_array_size (const cairo_array_t *array)
return array->size;
}
/**
/*< private >
* _cairo_user_data_array_init:
* @array: a #cairo_user_data_array_t
*
@ -373,7 +373,7 @@ _cairo_user_data_array_init (cairo_user_data_array_t *array)
_cairo_array_init (array, sizeof (cairo_user_data_slot_t));
}
/**
/*< private >
* _cairo_user_data_array_fini:
* @array: a #cairo_user_data_array_t
*
@ -400,7 +400,7 @@ _cairo_user_data_array_fini (cairo_user_data_array_t *array)
_cairo_array_fini (array);
}
/**
/*< private >
* _cairo_user_data_array_get_data:
* @array: a #cairo_user_data_array_t
* @key: the address of the #cairo_user_data_key_t the user data was
@ -433,7 +433,7 @@ _cairo_user_data_array_get_data (cairo_user_data_array_t *array,
return NULL;
}
/**
/*< private >
* _cairo_user_data_array_set_data:
* @array: a #cairo_user_data_array_t
* @key: the address of a #cairo_user_data_key_t to attach the user data to
@ -543,7 +543,7 @@ _cairo_array_sort (const cairo_array_t *array, int (*compar)(const void *, const
qsort (array->elements, array->num_elements, array->element_size, compar);
}
/**
/*< private >
* _cairo_array_pop_element:
* @array: a #cairo_array_t
* Returns: A TRUE if element successfully popped, FALSE if the array is empty.
@ -563,7 +563,7 @@ _cairo_array_pop_element (cairo_array_t *array, void *dst)
return FALSE;
}
/**
/*< private >
* _cairo_array_top_element:
* @array: a #cairo_array_t
* Returns: A pointer to the last of object or NULL if array is empty.