girepository: Document NULL-termination/length semantics for methods

This doesn’t change the existing behaviour, just documents it a bit more
clearly.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
This commit is contained in:
Philip Withnall 2024-02-07 15:45:28 +00:00
parent 01f9796532
commit 8f6926d4ce

View File

@ -267,6 +267,9 @@ gi_repository_prepend_search_path (GIRepository *repository,
* The list is internal to [class@GIRepository.Repository] and should not be
* freed, nor should its string elements.
*
* The list is guaranteed to be `NULL` terminated. The `NULL` terminator is not
* counted in @n_paths_out.
*
* Returns: (element-type filename) (transfer none) (array length=n_paths_out): list of search paths, most
* important first
* Since: 2.80
@ -336,6 +339,9 @@ gi_repository_prepend_library_path (GIRepository *repository,
* The list is internal to [class@GIRepository.Repository] and should not be
* freed, nor should its string elements.
*
* The list is guaranteed to be `NULL` terminated. The `NULL` terminator is not
* counted in @n_paths_out.
*
* Returns: (element-type filename) (transfer none) (array length=n_paths_out): list of search paths, most
* important first
* Since: 2.80
@ -1274,6 +1280,9 @@ gi_repository_get_version (GIRepository *repository,
* The list is internal to [class@GIRepository.Repository] and should not be
* freed, nor should its string elements.
*
* The list is guaranteed to be `NULL` terminated. The `NULL` terminator is not
* counted in @out_n_elements.
*
* Returns: (nullable) (array length=out_n_elements) (transfer none): Array of
* paths to shared libraries, or `NULL` if none are associated
* Since: 2.80
@ -1667,6 +1676,9 @@ find_namespace_latest (const char *namespace,
* Obtain an unordered list of versions (either currently loaded or
* available) for @namespace_ in this @repository.
*
* The list is guaranteed to be `NULL` terminated. The `NULL` terminator is not
* counted in @n_versions_out.
*
* Returns: (element-type utf8) (transfer full) (array length=n_versions_out): the array of versions.
* Since: 2.80
*/