cvs: php4 / README.EXT_SKEL /ext/skeleton create_stubs

hholzgra Tue Oct 31 03:30:11 2000 EDT Modified files: /php4 README.EXT_SKEL /php4/ext/skeleton create_stubs Log: support for short comments was added to ext_skel proto files theese will be used in proto comments in the source and as <refpurpose> information in the XML docs Index: php4/README.EXT_SKEL diff -u php4/README.EXT_SKEL:1.4 php4/README.EXT_SKEL:1.5 --- php4/README.EXT_SKEL:1.4 Sun Jul 16 11:51:00 2000 +++ php4/README.EXT_SKEL Tue Oct 31 03:30:10 2000 @@ -51,9 +51,13 @@ ']'s as there where '['s. Currently, it does not harm if you forget to do it or there is a wrong amount of ']'s, but this may change in the future. + An additional short description may be added after the parameters. + If present it will be filled into the 'proto' header comments in the stubs + code and the <refpurpose> tag in the XML documentation. + An example: - my_function(int arg1, int arg2 [, int arg3 [, int arg4]]) + my_function(int arg1, int arg2 [, int arg3 [, int arg4]]) this is my 1st Arguments arg3 and arg4 are optional. Index: php4/ext/skeleton/create_stubs diff -u php4/ext/skeleton/create_stubs:1.8 php4/ext/skeleton/create_stubs:1.9 --- php4/ext/skeleton/create_stubs:1.8 Mon Oct 23 00:31:30 2000 +++ php4/ext/skeleton/create_stubs Tue Oct 31 03:30:11 2000 @@ -147,6 +147,11 @@ } } + if (x = gobble("\\)")) { + sub(/^[ \t]+/, "", line) + fcomments[num_funcs] = line + } + funcs[num_funcs] = func_name types[num_funcs] = func_type maxargs[num_funcs] = args_max @@ -171,7 +176,7 @@ xmlstr = " <refentry id=\"function." refid "\">\n" \ " <refnamediv>\n" \ " <refname>" funcs[i] "</refname>\n" \ - " <refpurpose></refpurpose>\n" \ + " <refpurpose>" fcomments[i] "</refpurpose>\n" \ " </refnamediv>\n" \ " <refsect1>\n" \ " <title>Description</title>\n" \ @@ -261,7 +266,7 @@ } } - proto = proto closeopts ")\n */\nPHP_FUNCTION(" funcs[i] ")\n{" + proto = proto closeopts ")\n " fcomments[i] " */\nPHP_FUNCTION(" funcs[i] ")\n{" if (maxargs[i]) { zvals = zvals ";" fetchargs = fetchargs ") == FAILURE)" closefetch "{\n\t\tWRONG_PARAM_COUNT;\n\t}\n"