1
0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2025-10-23 01:52:48 +03:00

doc: Move brief to top, params to bottom of doc comments

This commit is contained in:
Nick Wellnhofer
2025-05-06 17:42:46 +02:00
parent 7bc7ae9db3
commit 9bbffec568
65 changed files with 6004 additions and 8035 deletions

View File

@@ -90,21 +90,23 @@ typedef struct _xmlSchema xmlSchema;
typedef xmlSchema *xmlSchemaPtr;
/**
* @param ctx the validation context
* @param msg the message
* Signature of an error callback from an XSD validation
*
* @...: extra arguments
*
* Signature of an error callback from an XSD validation
* @param ctx the validation context
* @param msg the message
*/
typedef void (*xmlSchemaValidityErrorFunc)
(void *ctx, const char *msg, ...) LIBXML_ATTR_FORMAT(2,3);
/**
* @param ctx the validation context
* @param msg the message
* Signature of a warning callback from an XSD validation
*
* @...: extra arguments
*
* Signature of a warning callback from an XSD validation
* @param ctx the validation context
* @param msg the message
*/
typedef void (*xmlSchemaValidityWarningFunc)
(void *ctx, const char *msg, ...) LIBXML_ATTR_FORMAT(2,3);
@@ -119,14 +121,13 @@ typedef struct _xmlSchemaValidCtxt xmlSchemaValidCtxt;
typedef xmlSchemaValidCtxt *xmlSchemaValidCtxtPtr;
/**
* @param ctx user provided context
* @param file returned file information
* @param line returned line information
*
* A schemas validation locator, a callback called by the validator.
* This is used when file or node information are not available
* to find out what file and line number are affected
*
* @param ctx user provided context
* @param file returned file information
* @param line returned line information
* @returns 0 in case of success and -1 in case of error
*/