diff options
| author | Hartmut Holzgraefe <hholzgra@php.net> | 2000-10-31 11:30:11 +0000 |
|---|---|---|
| committer | Hartmut Holzgraefe <hholzgra@php.net> | 2000-10-31 11:30:11 +0000 |
| commit | c420d653ee4f25ab48d1111ed8a80d82e9f47a3d (patch) | |
| tree | 3cc0369f848bee8baa29e4560dffb449592553e6 /README.EXT_SKEL | |
| parent | f589a3b587419c3fede092629a4b3bc65b20f505 (diff) | |
| download | php-git-c420d653ee4f25ab48d1111ed8a80d82e9f47a3d.tar.gz | |
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
Diffstat (limited to 'README.EXT_SKEL')
| -rw-r--r-- | README.EXT_SKEL | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/README.EXT_SKEL b/README.EXT_SKEL index cedda53c75..a887a85e5f 100644 --- a/README.EXT_SKEL +++ b/README.EXT_SKEL @@ -51,9 +51,13 @@ FORMAT OF FUNCTION DEFINITIONS FILE ']'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. |