Remove proto comments from C files

Closes GH-5758
This commit is contained in:
Max Semenik 2020-07-01 16:32:55 +03:00 committed by Máté Kocsis
parent 4757998650
commit 2b5de6f839
No known key found for this signature in database
GPG key ID: FD055E41728BF310
234 changed files with 3892 additions and 8084 deletions

View file

@ -564,8 +564,7 @@ PHP_MINFO_FUNCTION(basic) /* {{{ */
}
/* }}} */
/* {{{ proto mixed constant(string const_name)
Given the name of a constant this function will return the constant's associated value */
/* {{{ Given the name of a constant this function will return the constant's associated value */
PHP_FUNCTION(constant)
{
zend_string *const_name;
@ -592,8 +591,7 @@ PHP_FUNCTION(constant)
/* }}} */
#ifdef HAVE_INET_NTOP
/* {{{ proto string|false inet_ntop(string in_addr)
Converts a packed inet address to a human readable IP address string */
/* {{{ Converts a packed inet address to a human readable IP address string */
PHP_FUNCTION(inet_ntop)
{
char *address;
@ -624,8 +622,7 @@ PHP_FUNCTION(inet_ntop)
#endif /* HAVE_INET_NTOP */
#ifdef HAVE_INET_PTON
/* {{{ proto string|false inet_pton(string ip_address)
Converts a human readable IP address to a packed binary string */
/* {{{ Converts a human readable IP address to a packed binary string */
PHP_FUNCTION(inet_pton)
{
int ret, af = AF_INET;
@ -659,8 +656,7 @@ PHP_FUNCTION(inet_pton)
/* }}} */
#endif /* HAVE_INET_PTON */
/* {{{ proto int|false ip2long(string ip_address)
Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address */
/* {{{ Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address */
PHP_FUNCTION(ip2long)
{
char *addr;
@ -697,8 +693,7 @@ PHP_FUNCTION(ip2long)
}
/* }}} */
/* {{{ proto string|false long2ip(int proper_address)
Converts an (IPv4) Internet network address into a string in Internet standard dotted format */
/* {{{ Converts an (IPv4) Internet network address into a string in Internet standard dotted format */
PHP_FUNCTION(long2ip)
{
zend_ulong ip;
@ -732,8 +727,7 @@ PHP_FUNCTION(long2ip)
* System Functions *
********************/
/* {{{ proto string|array|false getenv([ string varname[, bool local_only]])
Get the value of an environment variable or every available environment variable
/* {{{ Get the value of an environment variable or every available environment variable
if no varname is present */
PHP_FUNCTION(getenv)
{
@ -830,8 +824,7 @@ PHP_FUNCTION(getenv)
/* }}} */
#ifdef HAVE_PUTENV
/* {{{ proto bool putenv(string setting)
Set the value of an environment variable */
/* {{{ Set the value of an environment variable */
PHP_FUNCTION(putenv)
{
char *setting;
@ -1028,8 +1021,7 @@ static int parse_opts(char * opts, opt_struct ** result)
}
/* }}} */
/* {{{ proto array|false getopt(string options [, array longopts [, int &optind]])
Get options from the command line argument list */
/* {{{ Get options from the command line argument list */
PHP_FUNCTION(getopt)
{
char *options = NULL, **argv = NULL;
@ -1210,8 +1202,7 @@ PHP_FUNCTION(getopt)
}
/* }}} */
/* {{{ proto void flush(void)
Flush the output buffer */
/* {{{ Flush the output buffer */
PHP_FUNCTION(flush)
{
ZEND_PARSE_PARAMETERS_NONE();
@ -1220,8 +1211,7 @@ PHP_FUNCTION(flush)
}
/* }}} */
/* {{{ proto int sleep(int seconds)
Delay for a given number of seconds */
/* {{{ Delay for a given number of seconds */
PHP_FUNCTION(sleep)
{
zend_long num;
@ -1239,8 +1229,7 @@ PHP_FUNCTION(sleep)
}
/* }}} */
/* {{{ proto void usleep(int micro_seconds)
Delay for a given number of micro seconds */
/* {{{ Delay for a given number of micro seconds */
PHP_FUNCTION(usleep)
{
zend_long num;
@ -1261,8 +1250,7 @@ PHP_FUNCTION(usleep)
/* }}} */
#if HAVE_NANOSLEEP
/* {{{ proto mixed time_nanosleep(int seconds, int nanoseconds)
Delay for a number of seconds and nano seconds */
/* {{{ Delay for a number of seconds and nano seconds */
PHP_FUNCTION(time_nanosleep)
{
zend_long tv_sec, tv_nsec;
@ -1300,8 +1288,7 @@ PHP_FUNCTION(time_nanosleep)
}
/* }}} */
/* {{{ proto bool time_sleep_until(float timestamp)
Make the script sleep until the specified time */
/* {{{ Make the script sleep until the specified time */
PHP_FUNCTION(time_sleep_until)
{
double target_secs;
@ -1343,8 +1330,7 @@ PHP_FUNCTION(time_sleep_until)
/* }}} */
#endif
/* {{{ proto string get_current_user(void)
Get the name of the owner of the current PHP script */
/* {{{ Get the name of the owner of the current PHP script */
PHP_FUNCTION(get_current_user)
{
ZEND_PARSE_PARAMETERS_NONE();
@ -1355,8 +1341,7 @@ PHP_FUNCTION(get_current_user)
static void add_config_entries(HashTable *hash, zval *return_value);
/* {{{ add_config_entry
*/
/* {{{ add_config_entry */
static void add_config_entry(zend_ulong h, zend_string *key, zval *entry, zval *retval)
{
if (Z_TYPE_P(entry) == IS_STRING) {
@ -1383,8 +1368,7 @@ static void add_config_entry(zend_ulong h, zend_string *key, zval *entry, zval *
}
/* }}} */
/* {{{ add_config_entries
*/
/* {{{ add_config_entries */
static void add_config_entries(HashTable *hash, zval *return_value) /* {{{ */
{
zend_ulong h;
@ -1397,8 +1381,7 @@ static void add_config_entries(HashTable *hash, zval *return_value) /* {{{ */
}
/* }}} */
/* {{{ proto string|array|false get_cfg_var(string option_name)
Get the value of a PHP configuration option */
/* {{{ Get the value of a PHP configuration option */
PHP_FUNCTION(get_cfg_var)
{
char *varname;
@ -1439,8 +1422,7 @@ error options:
4 = send to SAPI logger directly
*/
/* {{{ proto bool error_log(string message [, int message_type [, string destination [, string extra_headers]]])
Send an error message somewhere */
/* {{{ Send an error message somewhere */
PHP_FUNCTION(error_log)
{
char *message, *opt = NULL, *headers = NULL;
@ -1521,8 +1503,7 @@ PHPAPI int _php_error_log_ex(int opt_err, const char *message, size_t message_le
}
/* }}} */
/* {{{ proto array error_get_last()
Get the last occurred error as associative array. Returns NULL if there hasn't been an error yet. */
/* {{{ Get the last occurred error as associative array. Returns NULL if there hasn't been an error yet. */
PHP_FUNCTION(error_get_last)
{
ZEND_PARSE_PARAMETERS_NONE();
@ -1538,8 +1519,7 @@ PHP_FUNCTION(error_get_last)
}
/* }}} */
/* {{{ proto void error_clear_last(void)
Clear the last occurred error. */
/* {{{ Clear the last occurred error. */
PHP_FUNCTION(error_clear_last)
{
ZEND_PARSE_PARAMETERS_NONE();
@ -1559,8 +1539,7 @@ PHP_FUNCTION(error_clear_last)
}
/* }}} */
/* {{{ proto mixed call_user_func(mixed function_name [, mixed parameter] [, mixed ...])
Call a user function which is the first parameter
/* {{{ Call a user function which is the first parameter
Warning: This function is special-cased by zend_compile.c and so is usually bypassed */
PHP_FUNCTION(call_user_func)
{
@ -1584,8 +1563,7 @@ PHP_FUNCTION(call_user_func)
}
/* }}} */
/* {{{ proto mixed call_user_func_array(callable function, array parameters)
Call a user function which is the first parameter with the arguments contained in array
/* {{{ Call a user function which is the first parameter with the arguments contained in array
Warning: This function is special-cased by zend_compile.c and so is usually bypassed */
PHP_FUNCTION(call_user_func_array)
{
@ -1612,8 +1590,7 @@ PHP_FUNCTION(call_user_func_array)
}
/* }}} */
/* {{{ proto mixed forward_static_call(mixed function_name [, mixed parameter] [, mixed ...]) U
Call a user function which is the first parameter */
/* {{{ Call a user function which is the first parameter */
PHP_FUNCTION(forward_static_call)
{
zval retval;
@ -1648,8 +1625,7 @@ PHP_FUNCTION(forward_static_call)
}
/* }}} */
/* {{{ proto mixed forward_static_call_array(callable function, array parameters)
Call a static method which is the first parameter with the arguments contained in array */
/* {{{ Call a static method which is the first parameter with the arguments contained in array */
PHP_FUNCTION(forward_static_call_array)
{
zval *params, retval;
@ -1825,8 +1801,7 @@ PHPAPI void php_free_shutdown_functions(void) /* {{{ */
}
/* }}} */
/* {{{ proto false|null register_shutdown_function(callback function) U
Register a user-level function to be called on request termination */
/* {{{ Register a user-level function to be called on request termination */
PHP_FUNCTION(register_shutdown_function)
{
php_shutdown_function_entry shutdown_function_entry;
@ -1910,8 +1885,7 @@ ZEND_API void php_get_highlight_struct(zend_syntax_highlighter_ini *syntax_highl
}
/* }}} */
/* {{{ proto bool highlight_file(string file_name [, bool return] )
Syntax highlight a source file */
/* {{{ Syntax highlight a source file */
PHP_FUNCTION(highlight_file)
{
char *filename;
@ -1954,8 +1928,7 @@ PHP_FUNCTION(highlight_file)
}
/* }}} */
/* {{{ proto string php_strip_whitespace(string file_name)
Return source with stripped comments and whitespace */
/* {{{ Return source with stripped comments and whitespace */
PHP_FUNCTION(php_strip_whitespace)
{
char *filename;
@ -1987,8 +1960,7 @@ PHP_FUNCTION(php_strip_whitespace)
}
/* }}} */
/* {{{ proto bool highlight_string(string string [, bool return] )
Syntax highlight a string or optionally return it */
/* {{{ Syntax highlight a string or optionally return it */
PHP_FUNCTION(highlight_string)
{
zval *expr;
@ -2053,8 +2025,7 @@ PHP_FUNCTION(highlight_string)
} \
} while (0)
/* {{{ proto string|false ini_get(string varname)
Get a configuration option */
/* {{{ Get a configuration option */
PHP_FUNCTION(ini_get)
{
zend_string *varname, *val;
@ -2073,8 +2044,7 @@ PHP_FUNCTION(ini_get)
}
/* }}} */
/* {{{ proto array|false ini_get_all([string extension[, bool details = true]])
Get all configuration options */
/* {{{ Get all configuration options */
PHP_FUNCTION(ini_get_all)
{
char *extname = NULL;
@ -2155,8 +2125,7 @@ static int php_ini_check_path(char *option_name, size_t option_len, char *new_op
}
/* }}} */
/* {{{ proto string|false ini_set(string varname, string newvalue)
Set a configuration option, returns false on error and the old value of the configuration option on success */
/* {{{ Set a configuration option, returns false on error and the old value of the configuration option on success */
PHP_FUNCTION(ini_set)
{
zend_string *varname;
@ -2202,8 +2171,7 @@ PHP_FUNCTION(ini_set)
#undef INI_RETVAL_STR
/* {{{ proto void ini_restore(string varname)
Restore the value of a configuration option specified by varname */
/* {{{ Restore the value of a configuration option specified by varname */
PHP_FUNCTION(ini_restore)
{
zend_string *varname;
@ -2216,8 +2184,7 @@ PHP_FUNCTION(ini_restore)
}
/* }}} */
/* {{{ proto string|false set_include_path(string new_include_path)
Sets the include_path configuration option */
/* {{{ Sets the include_path configuration option */
PHP_FUNCTION(set_include_path)
{
zend_string *new_value;
@ -2246,8 +2213,7 @@ PHP_FUNCTION(set_include_path)
}
/* }}} */
/* {{{ proto string|false get_include_path()
Get the current include_path configuration option */
/* {{{ Get the current include_path configuration option */
PHP_FUNCTION(get_include_path)
{
char *str;
@ -2264,8 +2230,7 @@ PHP_FUNCTION(get_include_path)
}
/* }}} */
/* {{{ proto mixed print_r(mixed var [, bool return])
Prints out or returns information about the specified variable */
/* {{{ Prints out or returns information about the specified variable */
PHP_FUNCTION(print_r)
{
zval *var;
@ -2286,8 +2251,7 @@ PHP_FUNCTION(print_r)
}
/* }}} */
/* {{{ proto int connection_aborted(void)
Returns true if client disconnected */
/* {{{ Returns true if client disconnected */
PHP_FUNCTION(connection_aborted)
{
ZEND_PARSE_PARAMETERS_NONE();
@ -2296,8 +2260,7 @@ PHP_FUNCTION(connection_aborted)
}
/* }}} */
/* {{{ proto int connection_status(void)
Returns the connection status bitfield */
/* {{{ Returns the connection status bitfield */
PHP_FUNCTION(connection_status)
{
ZEND_PARSE_PARAMETERS_NONE();
@ -2306,8 +2269,7 @@ PHP_FUNCTION(connection_status)
}
/* }}} */
/* {{{ proto int ignore_user_abort([bool value])
Set whether we want to ignore a user abort event or not */
/* {{{ Set whether we want to ignore a user abort event or not */
PHP_FUNCTION(ignore_user_abort)
{
zend_bool arg = 0;
@ -2331,8 +2293,7 @@ PHP_FUNCTION(ignore_user_abort)
/* }}} */
#if HAVE_GETSERVBYNAME
/* {{{ proto int|false getservbyname(string service, string protocol)
Returns port associated with service. Protocol must be "tcp" or "udp" */
/* {{{ Returns port associated with service. Protocol must be "tcp" or "udp" */
PHP_FUNCTION(getservbyname)
{
char *name, *proto;
@ -2374,8 +2335,7 @@ PHP_FUNCTION(getservbyname)
#endif
#if HAVE_GETSERVBYPORT
/* {{{ proto string|false getservbyport(int port, string protocol)
Returns service name associated with port. Protocol must be "tcp" or "udp" */
/* {{{ Returns service name associated with port. Protocol must be "tcp" or "udp" */
PHP_FUNCTION(getservbyport)
{
char *proto;
@ -2400,8 +2360,7 @@ PHP_FUNCTION(getservbyport)
#endif
#if HAVE_GETPROTOBYNAME
/* {{{ proto int|false getprotobyname(string name)
Returns protocol number associated with name as per /etc/protocols */
/* {{{ Returns protocol number associated with name as per /etc/protocols */
PHP_FUNCTION(getprotobyname)
{
char *name;
@ -2424,8 +2383,7 @@ PHP_FUNCTION(getprotobyname)
#endif
#if HAVE_GETPROTOBYNUMBER
/* {{{ proto string|false getprotobynumber(int proto)
Returns protocol name associated with protocol number proto */
/* {{{ Returns protocol name associated with protocol number proto */
PHP_FUNCTION(getprotobynumber)
{
zend_long proto;
@ -2446,8 +2404,7 @@ PHP_FUNCTION(getprotobynumber)
/* }}} */
#endif
/* {{{ proto bool register_tick_function(string function_name [, mixed arg [, mixed ... ]])
Registers a tick callback function */
/* {{{ Registers a tick callback function */
PHP_FUNCTION(register_tick_function)
{
user_tick_function_entry tick_fe;
@ -2499,8 +2456,7 @@ PHP_FUNCTION(register_tick_function)
}
/* }}} */
/* {{{ proto void unregister_tick_function(string function_name)
Unregisters a tick callback function */
/* {{{ Unregisters a tick callback function */
PHP_FUNCTION(unregister_tick_function)
{
zval *function;
@ -2526,8 +2482,7 @@ PHP_FUNCTION(unregister_tick_function)
}
/* }}} */
/* {{{ proto bool is_uploaded_file(string path)
Check if file was created by rfc1867 upload */
/* {{{ Check if file was created by rfc1867 upload */
PHP_FUNCTION(is_uploaded_file)
{
char *path;
@ -2549,8 +2504,7 @@ PHP_FUNCTION(is_uploaded_file)
}
/* }}} */
/* {{{ proto bool move_uploaded_file(string path, string new_path)
Move a file if and only if it was created by an upload */
/* {{{ Move a file if and only if it was created by an upload */
PHP_FUNCTION(move_uploaded_file)
{
char *path, *new_path;
@ -2605,8 +2559,7 @@ PHP_FUNCTION(move_uploaded_file)
}
/* }}} */
/* {{{ php_simple_ini_parser_cb
*/
/* {{{ php_simple_ini_parser_cb */
static void php_simple_ini_parser_cb(zval *arg1, zval *arg2, zval *arg3, int callback_type, zval *arr)
{
switch (callback_type) {
@ -2662,8 +2615,7 @@ static void php_simple_ini_parser_cb(zval *arg1, zval *arg2, zval *arg3, int cal
}
/* }}} */
/* {{{ php_ini_parser_cb_with_sections
*/
/* {{{ php_ini_parser_cb_with_sections */
static void php_ini_parser_cb_with_sections(zval *arg1, zval *arg2, zval *arg3, int callback_type, zval *arr)
{
if (callback_type == ZEND_INI_PARSER_SECTION) {
@ -2683,8 +2635,7 @@ static void php_ini_parser_cb_with_sections(zval *arg1, zval *arg2, zval *arg3,
}
/* }}} */
/* {{{ proto array|false parse_ini_file(string filename [, bool process_sections [, int scanner_mode]])
Parse configuration file */
/* {{{ Parse configuration file */
PHP_FUNCTION(parse_ini_file)
{
char *filename = NULL;
@ -2725,8 +2676,7 @@ PHP_FUNCTION(parse_ini_file)
}
/* }}} */
/* {{{ proto array|false parse_ini_string(string ini_string [, bool process_sections [, int scanner_mode]])
Parse configuration string */
/* {{{ Parse configuration string */
PHP_FUNCTION(parse_ini_string)
{
char *string = NULL, *str = NULL;
@ -2784,8 +2734,7 @@ PHP_FUNCTION(config_get_hash) /* {{{ */
#endif
#ifdef HAVE_GETLOADAVG
/* {{{ proto array|false sys_getloadavg()
*/
/* {{{ */
PHP_FUNCTION(sys_getloadavg)
{
double load[3];