Mercurial > hg > xemacs-beta
view lib-src/pop.h @ 4695:fee33ab25966
Add arglist info for autoloaded functions and macros.
lisp/ChangeLog addition:
2009-09-20 Aidan Kehoe <kehoea@parhasard.net>
Add arglist information to docstrings for autoloaded functions and
macros.
* hyper-apropos.el (hyper-apropos-get-doc):
Treat autoload docstrings like subr docstrings; correct the regexp
used.
* help.el (describe-function-show-arglist):
This no longer treats autoloads specially.
(function-arglist): Treat autoload docstrings like subr docstrings.
(function-documentation): Treat documentation strings that are
zero-length after the arglist has been removed as indicating a
lack of documentation.
* cl-macs.el (case):
(ecase):
(typecase):
(etypecase):
(block):
(return):
(return-from):
(progv):
(lexical-let):
(lexical-let*):
(remf):
(callf):
(callf2):
(define-modify-macro):
(deftype):
(define-compiler-macro):
Rely on the autoload code to always show an arglist for these
functions, don't supply an ad-hoc one in the docstring.
These changes are for the most obvious functions; there are some
missed that would require changing argument names in the docstring
or in the function bodies.
* autoload.el (make-autoload):
Add arg list information to the doc string, using the same
approach as for subrs.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sun, 20 Sep 2009 23:50:05 +0100 |
| parents | bdfcf05f635b |
| children | 308d34e9f07d |
line wrap: on
line source
/* pop.h: Header file for the "pop.c" client POP3 protocol. Copyright (C) 1991, 1993, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. Written by Jonathan Kamens, jik@security.ov.com. This file is part of XEmacs. XEmacs is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. XEmacs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with XEmacs; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ /* Synched up with: FSF 22.0.50. */ #include <stdio.h> #define GETLINE_MIN 1024 /* the getline buffer starts out this */ /* size */ #define GETLINE_INCR 1024 /* the getline buffer is grown by this */ /* size when it needs to grow */ extern char pop_error[]; extern int pop_debug; struct _popserver { int file, data; char *buffer; int buffer_size, buffer_index; int in_multi; int trash_started; }; typedef struct _popserver *popserver; /* * Valid flags for the pop_open function. */ #define POP_NO_KERBEROS (1<<0) #define POP_NO_HESIOD (1<<1) #define POP_NO_GETPASS (1<<2) #ifdef __STDC__ #define _ARGS(a) a #else #define _ARGS(a) () #endif extern popserver pop_open _ARGS((char *host, char *username, char *password, int flags)); extern int pop_stat _ARGS((popserver server, int *count, int *size)); extern int pop_list _ARGS((popserver server, int message, int **IDs, int **size)); extern int pop_retrieve _ARGS((popserver server, int message, int markfrom, char **)); extern int pop_retrieve_first _ARGS((popserver server, int message, char **response)); extern int pop_retrieve_next _ARGS((popserver server, char **line)); extern int pop_retrieve_flush _ARGS((popserver server)); extern int pop_top_first _ARGS((popserver server, int message, int lines, char **response)); extern int pop_top_next _ARGS((popserver server, char **line)); extern int pop_top_flush _ARGS((popserver server)); extern int pop_multi_first _ARGS((popserver server, char *command, char **response)); extern int pop_multi_next _ARGS((popserver server, char **line)); extern int pop_multi_flush _ARGS((popserver server)); extern int pop_delete _ARGS((popserver server, int message)); extern int pop_noop _ARGS((popserver server)); extern int pop_last _ARGS((popserver server)); extern int pop_reset _ARGS((popserver server)); extern int pop_quit _ARGS((popserver server)); extern void pop_close _ARGS((popserver)); #undef _ARGS