Skip to content

John McEleney / mailutils

Go to a project
Toggle navigation
Toggle navigation pinning
Commit 3bd03f85 3bd03f85964a48e82d2c488cc5dc3c36c6dcab2a by Sergey Poznyakoff
Options

Update docstrings

1 parent 4f7a5cfb
Inline Side-by-side
Showing 7 changed files with 122 additions and 111 deletions
...@@ -76,7 +76,7 @@ _get_address_part (const char *func_name, address_get_fp fun, ...@@ -76,7 +76,7 @@ _get_address_part (const char *func_name, address_get_fp fun,
76 76
77 SCM_DEFINE (scm_mu_address_get_personal, "mu-address-get-personal", 1, 1, 0, 77 SCM_DEFINE (scm_mu_address_get_personal, "mu-address-get-personal", 1, 1, 0,
78 (SCM ADDRESS, SCM NUM), 78 (SCM ADDRESS, SCM NUM),
79 "Return personal part of an email address.\n") 79 "Return personal part of the NUMth email address from ADDRESS.\n")
80 #define FUNC_NAME s_scm_mu_address_get_personal 80 #define FUNC_NAME s_scm_mu_address_get_personal
81 { 81 {
82 return _get_address_part (FUNC_NAME, 82 return _get_address_part (FUNC_NAME,
...@@ -86,7 +86,7 @@ SCM_DEFINE (scm_mu_address_get_personal, "mu-address-get-personal", 1, 1, 0, ...@@ -86,7 +86,7 @@ SCM_DEFINE (scm_mu_address_get_personal, "mu-address-get-personal", 1, 1, 0,
86 86
87 SCM_DEFINE (scm_mu_address_get_comments, "mu-address-get-comments", 1, 1, 0, 87 SCM_DEFINE (scm_mu_address_get_comments, "mu-address-get-comments", 1, 1, 0,
88 (SCM ADDRESS, SCM NUM), 88 (SCM ADDRESS, SCM NUM),
89 "Return comment part of an email address.\n") 89 "Return comment part of the NUMth email address from ADDRESS.\n")
90 #define FUNC_NAME s_scm_mu_address_get_comments 90 #define FUNC_NAME s_scm_mu_address_get_comments
91 { 91 {
92 return _get_address_part (FUNC_NAME, 92 return _get_address_part (FUNC_NAME,
...@@ -96,7 +96,7 @@ SCM_DEFINE (scm_mu_address_get_comments, "mu-address-get-comments", 1, 1, 0, ...@@ -96,7 +96,7 @@ SCM_DEFINE (scm_mu_address_get_comments, "mu-address-get-comments", 1, 1, 0,
96 96
97 SCM_DEFINE (scm_mu_address_get_email, "mu-address-get-email", 1, 1, 0, 97 SCM_DEFINE (scm_mu_address_get_email, "mu-address-get-email", 1, 1, 0,
98 (SCM ADDRESS, SCM NUM), 98 (SCM ADDRESS, SCM NUM),
99 "Return email part of an email address.\n") 99 "Return email part of the NUMth email address from ADDRESS.\n")
100 #define FUNC_NAME s_scm_mu_address_get_email 100 #define FUNC_NAME s_scm_mu_address_get_email
101 { 101 {
102 return _get_address_part (FUNC_NAME, 102 return _get_address_part (FUNC_NAME,
...@@ -106,7 +106,7 @@ SCM_DEFINE (scm_mu_address_get_email, "mu-address-get-email", 1, 1, 0, ...@@ -106,7 +106,7 @@ SCM_DEFINE (scm_mu_address_get_email, "mu-address-get-email", 1, 1, 0,
106 106
107 SCM_DEFINE (scm_mu_address_get_domain, "mu-address-get-domain", 1, 1, 0, 107 SCM_DEFINE (scm_mu_address_get_domain, "mu-address-get-domain", 1, 1, 0,
108 (SCM ADDRESS, SCM NUM), 108 (SCM ADDRESS, SCM NUM),
109 "Return domain part of an email address.\n") 109 "Return domain part of the NUMth email address from ADDRESS.\n")
110 #define FUNC_NAME s_scm_mu_address_get_domain 110 #define FUNC_NAME s_scm_mu_address_get_domain
111 { 111 {
112 return _get_address_part (FUNC_NAME, 112 return _get_address_part (FUNC_NAME,
...@@ -116,7 +116,7 @@ SCM_DEFINE (scm_mu_address_get_domain, "mu-address-get-domain", 1, 1, 0, ...@@ -116,7 +116,7 @@ SCM_DEFINE (scm_mu_address_get_domain, "mu-address-get-domain", 1, 1, 0,
116 116
117 SCM_DEFINE (scm_mu_address_get_local, "mu-address-get-local", 1, 1, 0, 117 SCM_DEFINE (scm_mu_address_get_local, "mu-address-get-local", 1, 1, 0,
118 (SCM ADDRESS, SCM NUM), 118 (SCM ADDRESS, SCM NUM),
119 "Return local part of an email address.\n") 119 "Return local part of the NUMth email address from ADDRESS.\n")
120 #define FUNC_NAME s_scm_mu_address_get_local 120 #define FUNC_NAME s_scm_mu_address_get_local
121 { 121 {
122 return _get_address_part (FUNC_NAME, 122 return _get_address_part (FUNC_NAME,
...@@ -126,7 +126,7 @@ SCM_DEFINE (scm_mu_address_get_local, "mu-address-get-local", 1, 1, 0, ...@@ -126,7 +126,7 @@ SCM_DEFINE (scm_mu_address_get_local, "mu-address-get-local", 1, 1, 0,
126 126
127 SCM_DEFINE (scm_mu_address_get_count, "mu-address-get-count", 1, 0, 0, 127 SCM_DEFINE (scm_mu_address_get_count, "mu-address-get-count", 1, 0, 0,
128 (SCM ADDRESS), 128 (SCM ADDRESS),
129 "Return number of parts in email address.\n") 129 "Return number of parts in email address ADDRESS.\n")
130 #define FUNC_NAME s_scm_mu_address_get_count 130 #define FUNC_NAME s_scm_mu_address_get_count
131 { 131 {
132 mu_address_t addr; 132 mu_address_t addr;
...@@ -149,8 +149,8 @@ SCM_DEFINE (scm_mu_address_get_count, "mu-address-get-count", 1, 0, 0, ...@@ -149,8 +149,8 @@ SCM_DEFINE (scm_mu_address_get_count, "mu-address-get-count", 1, 0, 0,
149 149
150 SCM_DEFINE (scm_mu_username_to_email, "mu-username->email", 0, 1, 0, 150 SCM_DEFINE (scm_mu_username_to_email, "mu-username->email", 0, 1, 0,
151 (SCM NAME), 151 (SCM NAME),
152 "Deduce the email from the username. If NAME is omitted, current username\n" 152 "Deduce user's email address from his username. If NAME is omitted, \n"
153 "is assumed\n") 153 "current username is assumed\n")
154 #define FUNC_NAME s_scm_mu_username_to_email 154 #define FUNC_NAME s_scm_mu_username_to_email
155 { 155 {
156 const char *name; 156 const char *name;
......
...@@ -22,7 +22,8 @@ ...@@ -22,7 +22,8 @@
22 22
23 SCM_DEFINE (scm_mu_openlog, "mu-openlog", 3, 0, 0, 23 SCM_DEFINE (scm_mu_openlog, "mu-openlog", 3, 0, 0,
24 (SCM IDENT, SCM OPTION, SCM FACILITY), 24 (SCM IDENT, SCM OPTION, SCM FACILITY),
25 "Opens a connection to the system logger for Guile program.") 25 "Opens a connection to the system logger for Guile program.\n"
26 "IDENT, OPTION and FACILITY have the same meaning as in openlog(3)")
26 #define FUNC_NAME s_scm_mu_openlog 27 #define FUNC_NAME s_scm_mu_openlog
27 { 28 {
28 const char *ident; 29 const char *ident;
...@@ -57,7 +58,7 @@ SCM_DEFINE (scm_mu_openlog, "mu-openlog", 3, 0, 0, ...@@ -57,7 +58,7 @@ SCM_DEFINE (scm_mu_openlog, "mu-openlog", 3, 0, 0,
57 58
58 SCM_DEFINE (scm_mu_logger, "mu-logger", 2, 0, 0, 59 SCM_DEFINE (scm_mu_logger, "mu-logger", 2, 0, 0,
59 (SCM PRIO, SCM TEXT), 60 (SCM PRIO, SCM TEXT),
60 "Generates a log message to be distributed via syslogd.") 61 "Distributes TEXT via syslogd priority PRIO.")
61 #define FUNC_NAME s_scm_mu_logger 62 #define FUNC_NAME s_scm_mu_logger
62 { 63 {
63 int prio; 64 int prio;
...@@ -79,7 +80,7 @@ SCM_DEFINE (scm_mu_logger, "mu-logger", 2, 0, 0, ...@@ -79,7 +80,7 @@ SCM_DEFINE (scm_mu_logger, "mu-logger", 2, 0, 0,
79 80
80 SCM_DEFINE (scm_mu_closelog, "mu-closelog", 0, 0, 0, 81 SCM_DEFINE (scm_mu_closelog, "mu-closelog", 0, 0, 0,
81 (), 82 (),
82 "Closes the channel to the system logger open by mu-openlog.") 83 "Closes the channel to the system logger opened by @code{mu-openlog}.")
83 #define FUNC_NAME s_scm_mu_closelog 84 #define FUNC_NAME s_scm_mu_closelog
84 { 85 {
85 closelog (); 86 closelog ();
......
...@@ -106,7 +106,8 @@ mu_scm_is_mailbox (SCM scm) ...@@ -106,7 +106,8 @@ mu_scm_is_mailbox (SCM scm)
106 106
107 SCM_DEFINE (scm_mu_mail_directory, "mu-mail-directory", 0, 1, 0, 107 SCM_DEFINE (scm_mu_mail_directory, "mu-mail-directory", 0, 1, 0,
108 (SCM URL), 108 (SCM URL),
109 "") 109 "If URL is given, sets it as a name of the user's mail directory.\n"
110 "Returns the current value of the mail directory.")
110 #define FUNC_NAME s_scm_mu_mail_directory 111 #define FUNC_NAME s_scm_mu_mail_directory
111 { 112 {
112 if (!SCM_UNBNDP (URL)) 113 if (!SCM_UNBNDP (URL))
...@@ -120,7 +121,8 @@ SCM_DEFINE (scm_mu_mail_directory, "mu-mail-directory", 0, 1, 0, ...@@ -120,7 +121,8 @@ SCM_DEFINE (scm_mu_mail_directory, "mu-mail-directory", 0, 1, 0,
120 121
121 SCM_DEFINE (scm_mu_folder_directory, "mu-folder-directory", 0, 1, 0, 122 SCM_DEFINE (scm_mu_folder_directory, "mu-folder-directory", 0, 1, 0,
122 (SCM URL), 123 (SCM URL),
123 "") 124 "If URL is given, sets it as a name of the user's folder directory.\n"
125 "Returns the current value of the folder directory.")
124 #define FUNC_NAME s_scm_mu_folder_directory 126 #define FUNC_NAME s_scm_mu_folder_directory
125 { 127 {
126 if (!SCM_UNBNDP (URL)) 128 if (!SCM_UNBNDP (URL))
...@@ -134,14 +136,24 @@ SCM_DEFINE (scm_mu_folder_directory, "mu-folder-directory", 0, 1, 0, ...@@ -134,14 +136,24 @@ SCM_DEFINE (scm_mu_folder_directory, "mu-folder-directory", 0, 1, 0,
134 136
135 SCM_DEFINE (scm_mu_mailbox_open, "mu-mailbox-open", 2, 0, 0, 137 SCM_DEFINE (scm_mu_mailbox_open, "mu-mailbox-open", 2, 0, 0,
136 (SCM URL, SCM MODE), 138 (SCM URL, SCM MODE),
137 "Opens a mailbox specified by URL.") 139 "Opens the mailbox specified by URL. MODE is a string, consisting of\n"
140 "the characters described below, giving the access mode for the mailbox\n"
141 "\n"
142 "@multitable @columnfractions 0.20 0.70\n"
143 "@headitem MODE @tab Meaning\n"
144 "@item r @tab Open for reading.\n"
145 "@item w @tab Open for writing.\n"
146 "@item a @tab Open for appending to the end of the mailbox.\n"
147 "@item c @tab Create the mailbox if it does not exist.\n"
148 "@end multitable\n"
149 )
138 #define FUNC_NAME s_scm_mu_mailbox_open 150 #define FUNC_NAME s_scm_mu_mailbox_open
139 { 151 {
140 mu_mailbox_t mbox = NULL; 152 mu_mailbox_t mbox = NULL;
141 const char *mode_str; 153 const char *mode_str;
142 int mode = 0; 154 int mode = 0;
143 int status; 155 int status;
144 156
145 SCM_ASSERT (scm_is_string (URL), URL, SCM_ARG1, FUNC_NAME); 157 SCM_ASSERT (scm_is_string (URL), URL, SCM_ARG1, FUNC_NAME);
146 SCM_ASSERT (scm_is_string (MODE), MODE, SCM_ARG2, FUNC_NAME); 158 SCM_ASSERT (scm_is_string (MODE), MODE, SCM_ARG2, FUNC_NAME);
147 159
...@@ -186,7 +198,7 @@ SCM_DEFINE (scm_mu_mailbox_open, "mu-mailbox-open", 2, 0, 0, ...@@ -186,7 +198,7 @@ SCM_DEFINE (scm_mu_mailbox_open, "mu-mailbox-open", 2, 0, 0,
186 #undef FUNC_NAME 198 #undef FUNC_NAME
187 199
188 SCM_DEFINE (scm_mu_mailbox_close, "mu-mailbox-close", 1, 0, 0, 200 SCM_DEFINE (scm_mu_mailbox_close, "mu-mailbox-close", 1, 0, 0,
189 (SCM MBOX), "Closes mailbox MBOX") 201 (SCM MBOX), "Closes mailbox MBOX.")
190 #define FUNC_NAME s_scm_mu_mailbox_close 202 #define FUNC_NAME s_scm_mu_mailbox_close
191 { 203 {
192 struct mu_mailbox *mum; 204 struct mu_mailbox *mum;
...@@ -201,25 +213,31 @@ SCM_DEFINE (scm_mu_mailbox_close, "mu-mailbox-close", 1, 0, 0, ...@@ -201,25 +213,31 @@ SCM_DEFINE (scm_mu_mailbox_close, "mu-mailbox-close", 1, 0, 0,
201 213
202 SCM_DEFINE (scm_mu_mailbox_get_url, "mu-mailbox-get-url", 1, 0, 0, 214 SCM_DEFINE (scm_mu_mailbox_get_url, "mu-mailbox-get-url", 1, 0, 0,
203 (SCM MBOX), 215 (SCM MBOX),
204 "Returns the URL of the mailbox.") 216 "Returns url of the mailbox MBOX.")
205 #define FUNC_NAME s_scm_mu_mailbox_get_url 217 #define FUNC_NAME s_scm_mu_mailbox_get_url
206 { 218 {
207 struct mu_mailbox *mum; 219 struct mu_mailbox *mum;
208 mu_url_t url; 220 mu_url_t url;
209 221 int status;
222
210 SCM_ASSERT (mu_scm_is_mailbox (MBOX), MBOX, SCM_ARG1, FUNC_NAME); 223 SCM_ASSERT (mu_scm_is_mailbox (MBOX), MBOX, SCM_ARG1, FUNC_NAME);
211 mum = (struct mu_mailbox *) SCM_CDR (MBOX); 224 mum = (struct mu_mailbox *) SCM_CDR (MBOX);
212 mu_mailbox_get_url (mum->mbox, &url); 225 status = mu_mailbox_get_url (mum->mbox, &url);
226 if (status)
227 mu_scm_error (FUNC_NAME, status,
228 "Cannot get mailbox url",
229 SCM_BOOL_F);
230
213 return scm_makfrom0str (mu_url_to_string (url)); 231 return scm_makfrom0str (mu_url_to_string (url));
214 } 232 }
215 #undef FUNC_NAME 233 #undef FUNC_NAME
216 234
217 SCM_DEFINE (scm_mu_mailbox_get_port, "mu-mailbox-get-port", 2, 0, 0, 235 SCM_DEFINE (scm_mu_mailbox_get_port, "mu-mailbox-get-port", 2, 0, 0,
218 (SCM MBOX, SCM MODE), 236 (SCM MBOX, SCM MODE),
219 "Returns a port associated with the contents of the MBOX.\n" 237 "Returns a port associated with the contents of the MBOX.\n"
220 "MODE is a string defining operation mode of the stream. It may\n" 238 "MODE is a string defining operation mode of the stream. It may\n"
221 "contain any of the two characters: \"r\" for reading, \"w\" for\n" 239 "contain any of the two characters: @samp{r} for reading, @samp{w} for\n"
222 "writing.\n") 240 "writing.\n")
223 #define FUNC_NAME s_scm_mu_mailbox_get_port 241 #define FUNC_NAME s_scm_mu_mailbox_get_port
224 { 242 {
225 struct mu_mailbox *mum; 243 struct mu_mailbox *mum;
...@@ -240,7 +258,8 @@ SCM_DEFINE (scm_mu_mailbox_get_port, "mu-mailbox-get-port", 2, 0, 0, ...@@ -240,7 +258,8 @@ SCM_DEFINE (scm_mu_mailbox_get_port, "mu-mailbox-get-port", 2, 0, 0,
240 #undef FUNC_NAME 258 #undef FUNC_NAME
241 259
242 SCM_DEFINE (scm_mu_mailbox_get_message, "mu-mailbox-get-message", 2, 0, 0, 260 SCM_DEFINE (scm_mu_mailbox_get_message, "mu-mailbox-get-message", 2, 0, 0,
243 (SCM MBOX, SCM MSGNO), "Retrieve from MBOX message # MSGNO.") 261 (SCM MBOX, SCM MSGNO),
262 "Retrieve from message #MSGNO from the mailbox MBOX.")
244 #define FUNC_NAME s_scm_mu_mailbox_get_message 263 #define FUNC_NAME s_scm_mu_mailbox_get_message
245 { 264 {
246 size_t msgno; 265 size_t msgno;
...@@ -265,7 +284,8 @@ SCM_DEFINE (scm_mu_mailbox_get_message, "mu-mailbox-get-message", 2, 0, 0, ...@@ -265,7 +284,8 @@ SCM_DEFINE (scm_mu_mailbox_get_message, "mu-mailbox-get-message", 2, 0, 0,
265 #undef FUNC_NAME 284 #undef FUNC_NAME
266 285
267 SCM_DEFINE (scm_mu_mailbox_messages_count, "mu-mailbox-messages-count", 1, 0, 0, 286 SCM_DEFINE (scm_mu_mailbox_messages_count, "mu-mailbox-messages-count", 1, 0, 0,
268 (SCM MBOX), "Returns number of messages in the mailbox.") 287 (SCM MBOX),
288 "Returns number of messages in the mailbox MBOX.")
269 #define FUNC_NAME s_scm_mu_mailbox_messages_count 289 #define FUNC_NAME s_scm_mu_mailbox_messages_count
270 { 290 {
271 struct mu_mailbox *mum; 291 struct mu_mailbox *mum;
...@@ -285,7 +305,8 @@ SCM_DEFINE (scm_mu_mailbox_messages_count, "mu-mailbox-messages-count", 1, 0, 0, ...@@ -285,7 +305,8 @@ SCM_DEFINE (scm_mu_mailbox_messages_count, "mu-mailbox-messages-count", 1, 0, 0,
285 #undef FUNC_NAME 305 #undef FUNC_NAME
286 306
287 SCM_DEFINE (scm_mu_mailbox_expunge, "mu-mailbox-expunge", 1, 0, 0, 307 SCM_DEFINE (scm_mu_mailbox_expunge, "mu-mailbox-expunge", 1, 0, 0,
288 (SCM MBOX), "Expunges deleted messages from the mailbox.") 308 (SCM MBOX),
309 "Expunges deleted messages from the mailbox MBOX.")
289 #define FUNC_NAME s_scm_mu_mailbox_expunge 310 #define FUNC_NAME s_scm_mu_mailbox_expunge
290 { 311 {
291 struct mu_mailbox *mum; 312 struct mu_mailbox *mum;
...@@ -302,27 +323,9 @@ SCM_DEFINE (scm_mu_mailbox_expunge, "mu-mailbox-expunge", 1, 0, 0, ...@@ -302,27 +323,9 @@ SCM_DEFINE (scm_mu_mailbox_expunge, "mu-mailbox-expunge", 1, 0, 0,
302 } 323 }
303 #undef FUNC_NAME 324 #undef FUNC_NAME
304 325
305 SCM_DEFINE (scm_mu_mailbox_url, "mu-mailbox-url", 1, 0, 0,
306 (SCM MBOX), "Returns the URL of the mailbox")
307 #define FUNC_NAME s_scm_mu_mailbox_url
308 {
309 struct mu_mailbox *mum;
310 mu_url_t url;
311 int status;
312
313 SCM_ASSERT (mu_scm_is_mailbox (MBOX), MBOX, SCM_ARG1, FUNC_NAME);
314 mum = (struct mu_mailbox *) SCM_CDR (MBOX);
315 mu_mailbox_get_url (mum->mbox, &url);
316 if (status)
317 mu_scm_error (FUNC_NAME, status,
318 "Cannot get mailbox URL",
319 SCM_BOOL_F);
320 return scm_makfrom0str (mu_url_to_string (url));
321 }
322 #undef FUNC_NAME
323
324 SCM_DEFINE (scm_mu_mailbox_append_message, "mu-mailbox-append-message", 2, 0, 0, 326 SCM_DEFINE (scm_mu_mailbox_append_message, "mu-mailbox-append-message", 2, 0, 0,
325 (SCM MBOX, SCM MESG), "Appends the message to the mailbox") 327 (SCM MBOX, SCM MESG),
328 "Appends message MESG to the mailbox MBOX.")
326 #define FUNC_NAME s_scm_mu_mailbox_append_message 329 #define FUNC_NAME s_scm_mu_mailbox_append_message
327 { 330 {
328 struct mu_mailbox *mum; 331 struct mu_mailbox *mum;
......
...@@ -176,7 +176,7 @@ mu_scm_is_message (SCM scm) ...@@ -176,7 +176,7 @@ mu_scm_is_message (SCM scm)
176 176
177 SCM_DEFINE (scm_mu_message_create, "mu-message-create", 0, 0, 0, 177 SCM_DEFINE (scm_mu_message_create, "mu-message-create", 0, 0, 0,
178 (), 178 (),
179 "Creates an empty message.") 179 "Creates an empty message.\n")
180 #define FUNC_NAME s_scm_mu_message_create 180 #define FUNC_NAME s_scm_mu_message_create
181 { 181 {
182 mu_message_t msg; 182 mu_message_t msg;
...@@ -188,7 +188,7 @@ SCM_DEFINE (scm_mu_message_create, "mu-message-create", 0, 0, 0, ...@@ -188,7 +188,7 @@ SCM_DEFINE (scm_mu_message_create, "mu-message-create", 0, 0, 0,
188 /* FIXME: This changes envelope date */ 188 /* FIXME: This changes envelope date */
189 SCM_DEFINE (scm_mu_message_copy, "mu-message-copy", 1, 0, 0, 189 SCM_DEFINE (scm_mu_message_copy, "mu-message-copy", 1, 0, 0,
190 (SCM MESG), 190 (SCM MESG),
191 "Creates the copy of the given message.\n") 191 "Creates the copy of the message MESG.\n")
192 #define FUNC_NAME s_scm_mu_message_copy 192 #define FUNC_NAME s_scm_mu_message_copy
193 { 193 {
194 mu_message_t msg, newmsg; 194 mu_message_t msg, newmsg;
...@@ -249,7 +249,7 @@ SCM_DEFINE (scm_mu_message_copy, "mu-message-copy", 1, 0, 0, ...@@ -249,7 +249,7 @@ SCM_DEFINE (scm_mu_message_copy, "mu-message-copy", 1, 0, 0,
249 249
250 SCM_DEFINE (scm_mu_message_destroy, "mu-message-destroy", 1, 0, 0, 250 SCM_DEFINE (scm_mu_message_destroy, "mu-message-destroy", 1, 0, 0,
251 (SCM MESG), 251 (SCM MESG),
252 "Destroys the message.") 252 "Destroys the message MESG.")
253 #define FUNC_NAME s_scm_mu_message_destroy 253 #define FUNC_NAME s_scm_mu_message_destroy
254 { 254 {
255 struct mu_message *mum; 255 struct mu_message *mum;
...@@ -263,10 +263,10 @@ SCM_DEFINE (scm_mu_message_destroy, "mu-message-destroy", 1, 0, 0, ...@@ -263,10 +263,10 @@ SCM_DEFINE (scm_mu_message_destroy, "mu-message-destroy", 1, 0, 0,
263 263
264 SCM_DEFINE (scm_mu_message_set_header, "mu-message-set-header", 3, 1, 0, 264 SCM_DEFINE (scm_mu_message_set_header, "mu-message-set-header", 3, 1, 0,
265 (SCM MESG, SCM HEADER, SCM VALUE, SCM REPLACE), 265 (SCM MESG, SCM HEADER, SCM VALUE, SCM REPLACE),
266 "Sets new VALUE to the header HEADER of the message MESG.\n" 266 "Sets new VALUE to the header HEADER of the message MESG.\n"
267 "If the HEADER is already present in the message its value\n" 267 "If HEADER is already present in the message its value\n"
268 "is replaced with the suplied one iff the optional REPLACE is\n" 268 "is replaced with the suplied one iff the optional REPLACE is\n"
269 "#t. Otherwise new header is created and appended.") 269 "#t. Otherwise, a new header is created and appended.")
270 #define FUNC_NAME s_scm_mu_message_set_header 270 #define FUNC_NAME s_scm_mu_message_set_header
271 { 271 {
272 mu_message_t msg; 272 mu_message_t msg;
...@@ -306,7 +306,7 @@ SCM_DEFINE (scm_mu_message_set_header, "mu-message-set-header", 3, 1, 0, ...@@ -306,7 +306,7 @@ SCM_DEFINE (scm_mu_message_set_header, "mu-message-set-header", 3, 1, 0,
306 306
307 SCM_DEFINE (scm_mu_message_get_size, "mu-message-get-size", 1, 0, 0, 307 SCM_DEFINE (scm_mu_message_get_size, "mu-message-get-size", 1, 0, 0,
308 (SCM MESG), 308 (SCM MESG),
309 "Returns the size of the given message.") 309 "Returns the size of the message MESG\n.")
310 #define FUNC_NAME s_scm_mu_message_get_size 310 #define FUNC_NAME s_scm_mu_message_get_size
311 { 311 {
312 mu_message_t msg; 312 mu_message_t msg;
...@@ -320,7 +320,7 @@ SCM_DEFINE (scm_mu_message_get_size, "mu-message-get-size", 1, 0, 0, ...@@ -320,7 +320,7 @@ SCM_DEFINE (scm_mu_message_get_size, "mu-message-get-size", 1, 0, 0,
320 320
321 SCM_DEFINE (scm_mu_message_get_lines, "mu-message-get-lines", 1, 0, 0, 321 SCM_DEFINE (scm_mu_message_get_lines, "mu-message-get-lines", 1, 0, 0,
322 (SCM MESG), 322 (SCM MESG),
323 "Returns number of lines in the given message.") 323 "Returns number of lines in the given message.\n")
324 #define FUNC_NAME s_scm_mu_message_get_lines 324 #define FUNC_NAME s_scm_mu_message_get_lines
325 { 325 {
326 mu_message_t msg; 326 mu_message_t msg;
...@@ -341,7 +341,7 @@ SCM_DEFINE (scm_mu_message_get_lines, "mu-message-get-lines", 1, 0, 0, ...@@ -341,7 +341,7 @@ SCM_DEFINE (scm_mu_message_get_lines, "mu-message-get-lines", 1, 0, 0,
341 341
342 SCM_DEFINE (scm_mu_message_get_sender, "mu-message-get-sender", 1, 0, 0, 342 SCM_DEFINE (scm_mu_message_get_sender, "mu-message-get-sender", 1, 0, 0,
343 (SCM MESG), 343 (SCM MESG),
344 "Returns the sender email address for the message MESG.") 344 "Returns email address of the sender of the message MESG.\n")
345 #define FUNC_NAME s_scm_mu_message_get_sender 345 #define FUNC_NAME s_scm_mu_message_get_sender
346 { 346 {
347 mu_message_t msg; 347 mu_message_t msg;
...@@ -368,7 +368,7 @@ SCM_DEFINE (scm_mu_message_get_sender, "mu-message-get-sender", 1, 0, 0, ...@@ -368,7 +368,7 @@ SCM_DEFINE (scm_mu_message_get_sender, "mu-message-get-sender", 1, 0, 0,
368 368
369 SCM_DEFINE (scm_mu_message_get_header, "mu-message-get-header", 2, 0, 0, 369 SCM_DEFINE (scm_mu_message_get_header, "mu-message-get-header", 2, 0, 0,
370 (SCM MESG, SCM HEADER), 370 (SCM MESG, SCM HEADER),
371 "Returns the header value of the HEADER in the MESG.") 371 "Returns value of the header HEADER from the message MESG.\n")
372 #define FUNC_NAME s_scm_mu_message_get_header 372 #define FUNC_NAME s_scm_mu_message_get_header
373 { 373 {
374 mu_message_t msg; 374 mu_message_t msg;
...@@ -424,9 +424,8 @@ string_sloppy_member (SCM lst, char *name) ...@@ -424,9 +424,8 @@ string_sloppy_member (SCM lst, char *name)
424 424
425 SCM_DEFINE (scm_mu_message_get_header_fields, "mu-message-get-header-fields", 1, 1, 0, 425 SCM_DEFINE (scm_mu_message_get_header_fields, "mu-message-get-header-fields", 1, 1, 0,
426 (SCM MESG, SCM HEADERS), 426 (SCM MESG, SCM HEADERS),
427 "Returns the list of headers in the MESG. If optional HEADERS is\n" 427 "Returns the list of headers in the message MESG. Optional argument\n"
428 "specified it should be a list of header names to restrict return\n" 428 "HEADERS gives a list of header names to restrict return value to.\n")
429 "value to.\n")
430 #define FUNC_NAME s_scm_mu_message_get_header_fields 429 #define FUNC_NAME s_scm_mu_message_get_header_fields
431 { 430 {
432 size_t i, nfields = 0; 431 size_t i, nfields = 0;
...@@ -498,11 +497,12 @@ SCM_DEFINE (scm_mu_message_get_header_fields, "mu-message-get-header-fields", 1, ...@@ -498,11 +497,12 @@ SCM_DEFINE (scm_mu_message_get_header_fields, "mu-message-get-header-fields", 1,
498 497
499 SCM_DEFINE (scm_mu_message_set_header_fields, "mu-message-set-header-fields", 2, 1, 0, 498 SCM_DEFINE (scm_mu_message_set_header_fields, "mu-message-set-header-fields", 2, 1, 0,
500 (SCM MESG, SCM LIST, SCM REPLACE), 499 (SCM MESG, SCM LIST, SCM REPLACE),
501 "Set the headers in the message MESG from LIST\n" 500 "Set the headers in the message MESG from LIST\n"
502 "LIST is a list of (cons HEADER VALUE)\n" 501 "LIST is a list of conses (cons HEADER VALUE). The function sets\n"
503 "Optional parameter REPLACE spceifies whether the new header\n" 502 "these headers in the message MESG.\n"
504 "values should replace the headers already present in the\n" 503 "Optional parameter REPLACE specifies whether the new header\n"
505 "message.") 504 "values should replace the headers already present in the\n"
505 "message.")
506 #define FUNC_NAME s_scm_mu_message_set_header_fields 506 #define FUNC_NAME s_scm_mu_message_set_header_fields
507 { 507 {
508 mu_message_t msg; 508 mu_message_t msg;
...@@ -554,8 +554,9 @@ SCM_DEFINE (scm_mu_message_set_header_fields, "mu-message-set-header-fields", 2, ...@@ -554,8 +554,9 @@ SCM_DEFINE (scm_mu_message_set_header_fields, "mu-message-set-header-fields", 2,
554 554
555 SCM_DEFINE (scm_mu_message_delete, "mu-message-delete", 1, 1, 0, 555 SCM_DEFINE (scm_mu_message_delete, "mu-message-delete", 1, 1, 0,
556 (SCM MESG, SCM FLAG), 556 (SCM MESG, SCM FLAG),
557 "Mark given message as deleted. Optional FLAG allows to toggle deleted mark\n" 557 "Mark the message MESG as deleted. Optional argument FLAG allows to toggle\n"
558 "The message is deleted if it is #t and undeleted if it is #f") 558 "deletion mark. The message is deleted if it is @code{#t} and undeleted if\n"
559 "it is @code{#f}")
559 #define FUNC_NAME s_scm_mu_message_delete 560 #define FUNC_NAME s_scm_mu_message_delete
560 { 561 {
561 mu_message_t msg; 562 mu_message_t msg;
...@@ -591,7 +592,7 @@ SCM_DEFINE (scm_mu_message_delete, "mu-message-delete", 1, 1, 0, ...@@ -591,7 +592,7 @@ SCM_DEFINE (scm_mu_message_delete, "mu-message-delete", 1, 1, 0,
591 592
592 SCM_DEFINE (scm_mu_message_get_flag, "mu-message-get-flag", 2, 0, 0, 593 SCM_DEFINE (scm_mu_message_get_flag, "mu-message-get-flag", 2, 0, 0,
593 (SCM MESG, SCM FLAG), 594 (SCM MESG, SCM FLAG),
594 "Return value of the attribute FLAG.") 595 "Return value of the attribute FLAG of the message MESG.")
595 #define FUNC_NAME s_scm_mu_message_get_flag 596 #define FUNC_NAME s_scm_mu_message_get_flag
596 { 597 {
597 mu_message_t msg; 598 mu_message_t msg;
...@@ -652,8 +653,8 @@ SCM_DEFINE (scm_mu_message_get_flag, "mu-message-get-flag", 2, 0, 0, ...@@ -652,8 +653,8 @@ SCM_DEFINE (scm_mu_message_get_flag, "mu-message-get-flag", 2, 0, 0,
652 653
653 SCM_DEFINE (scm_mu_message_set_flag, "mu-message-set-flag", 2, 1, 0, 654 SCM_DEFINE (scm_mu_message_set_flag, "mu-message-set-flag", 2, 1, 0,
654 (SCM MESG, SCM FLAG, SCM VALUE), 655 (SCM MESG, SCM FLAG, SCM VALUE),
655 "Set the given attribute of the message. If optional VALUE is #f, the\n" 656 "Set the attribute FLAG of the message MESG. If optional VALUE is #f, the\n"
656 "attribute is unset.") 657 "attribute is unset.")
657 #define FUNC_NAME s_scm_mu_message_set_flag 658 #define FUNC_NAME s_scm_mu_message_set_flag
658 { 659 {
659 mu_message_t msg; 660 mu_message_t msg;
...@@ -751,7 +752,7 @@ SCM_DEFINE (scm_mu_message_set_flag, "mu-message-set-flag", 2, 1, 0, ...@@ -751,7 +752,7 @@ SCM_DEFINE (scm_mu_message_set_flag, "mu-message-set-flag", 2, 1, 0,
751 752
752 SCM_DEFINE (scm_mu_message_get_user_flag, "mu-message-get-user-flag", 2, 0, 0, 753 SCM_DEFINE (scm_mu_message_get_user_flag, "mu-message-get-user-flag", 2, 0, 0,
753 (SCM MESG, SCM FLAG), 754 (SCM MESG, SCM FLAG),
754 "Returns value of the user attribute FLAG.") 755 "Return the value of the user attribute FLAG from the message MESG.")
755 #define FUNC_NAME s_scm_mu_message_get_user_flag 756 #define FUNC_NAME s_scm_mu_message_get_user_flag
756 { 757 {
757 mu_message_t msg; 758 mu_message_t msg;
...@@ -773,8 +774,8 @@ SCM_DEFINE (scm_mu_message_get_user_flag, "mu-message-get-user-flag", 2, 0, 0, ...@@ -773,8 +774,8 @@ SCM_DEFINE (scm_mu_message_get_user_flag, "mu-message-get-user-flag", 2, 0, 0,
773 774
774 SCM_DEFINE (scm_mu_message_set_user_flag, "mu-message-set-user-flag", 2, 1, 0, 775 SCM_DEFINE (scm_mu_message_set_user_flag, "mu-message-set-user-flag", 2, 1, 0,
775 (SCM MESG, SCM FLAG, SCM VALUE), 776 (SCM MESG, SCM FLAG, SCM VALUE),
776 "Set the given user attribute of the message. If optional VALUE is\n" 777 "Set the given user attribute FLAG in the message MESG. If optional argumen\n"
777 "#f, the attribute is unset.") 778 "VALUE is @samp{#f}, the attribute is unset.")
778 #define FUNC_NAME s_scm_mu_message_set_user_flag 779 #define FUNC_NAME s_scm_mu_message_set_user_flag
779 { 780 {
780 mu_message_t msg; 781 mu_message_t msg;
...@@ -808,13 +809,13 @@ SCM_DEFINE (scm_mu_message_set_user_flag, "mu-message-set-user-flag", 2, 1, 0, ...@@ -808,13 +809,13 @@ SCM_DEFINE (scm_mu_message_set_user_flag, "mu-message-set-user-flag", 2, 1, 0,
808 809
809 SCM_DEFINE (scm_mu_message_get_port, "mu-message-get-port", 2, 1, 0, 810 SCM_DEFINE (scm_mu_message_get_port, "mu-message-get-port", 2, 1, 0,
810 (SCM MESG, SCM MODE, SCM FULL), 811 (SCM MESG, SCM MODE, SCM FULL),
811 "Returns a port associated with the given MESG. MODE is a string\n" 812 "Returns a port associated with the given MESG. MODE is a string\n"
812 "defining operation mode of the stream. It may contain any of the\n" 813 "defining operation mode of the stream. It may contain any of the\n"
813 "two characters: \"r\" for reading, \"w\" for writing.\n" 814 "two characters: @samp{r} for reading, @samp{w} for writing.\n"
814 "If optional FULL argument specified, it should be a boolean value.\n" 815 "If optional argument FULL is specified, it should be a boolean value.\n"
815 "If it is #t then the returned port will allow access to any\n" 816 "If it is @samp{#t} then the returned port will allow access to any\n"
816 "part of the message (including headers). If it is #f then the port\n" 817 "part of the message (including headers). If it is @code{#f} then the port\n"
817 "accesses only the message body (the default).\n") 818 "accesses only the message body (the default).\n")
818 #define FUNC_NAME s_scm_mu_message_get_port 819 #define FUNC_NAME s_scm_mu_message_get_port
819 { 820 {
820 mu_message_t msg; 821 mu_message_t msg;
...@@ -879,7 +880,7 @@ SCM_DEFINE (scm_mu_message_get_body, "mu-message-get-body", 1, 0, 0, ...@@ -879,7 +880,7 @@ SCM_DEFINE (scm_mu_message_get_body, "mu-message-get-body", 1, 0, 0,
879 880
880 SCM_DEFINE (scm_mu_message_multipart_p, "mu-message-multipart?", 1, 0, 0, 881 SCM_DEFINE (scm_mu_message_multipart_p, "mu-message-multipart?", 1, 0, 0,
881 (SCM MESG), 882 (SCM MESG),
882 "Returns #t if MESG is a multipart MIME message.") 883 "Returns @code{#t} if MESG is a multipart @acronym{MIME} message.")
883 #define FUNC_NAME s_scm_mu_message_multipart_p 884 #define FUNC_NAME s_scm_mu_message_multipart_p
884 { 885 {
885 mu_message_t msg; 886 mu_message_t msg;
...@@ -894,8 +895,8 @@ SCM_DEFINE (scm_mu_message_multipart_p, "mu-message-multipart?", 1, 0, 0, ...@@ -894,8 +895,8 @@ SCM_DEFINE (scm_mu_message_multipart_p, "mu-message-multipart?", 1, 0, 0,
894 895
895 SCM_DEFINE (scm_mu_message_get_num_parts, "mu-message-get-num-parts", 1, 0, 0, 896 SCM_DEFINE (scm_mu_message_get_num_parts, "mu-message-get-num-parts", 1, 0, 0,
896 (SCM MESG), 897 (SCM MESG),
897 "Returns number of parts in a multipart MIME message. Returns\n" 898 "Returns number of parts in a multipart @acronym{MIME} message. Returns\n"
898 "#f if the argument is not a multipart message.") 899 "@code{#f} if the argument is not a multipart message.")
899 #define FUNC_NAME s_scm_mu_message_get_num_parts 900 #define FUNC_NAME s_scm_mu_message_get_num_parts
900 { 901 {
901 mu_message_t msg; 902 mu_message_t msg;
...@@ -920,7 +921,7 @@ SCM_DEFINE (scm_mu_message_get_num_parts, "mu-message-get-num-parts", 1, 0, 0, ...@@ -920,7 +921,7 @@ SCM_DEFINE (scm_mu_message_get_num_parts, "mu-message-get-num-parts", 1, 0, 0,
920 921
921 SCM_DEFINE (scm_mu_message_get_part, "mu-message-get-part", 2, 0, 0, 922 SCM_DEFINE (scm_mu_message_get_part, "mu-message-get-part", 2, 0, 0,
922 (SCM MESG, SCM PART), 923 (SCM MESG, SCM PART),
923 "Returns part number PART from a multipart MIME message.") 924 "Returns part #PART from a multipart @acronym{MIME} message MESG.")
924 #define FUNC_NAME s_scm_mu_message_get_part 925 #define FUNC_NAME s_scm_mu_message_get_part
925 { 926 {
926 mu_message_t msg, submsg; 927 mu_message_t msg, submsg;
...@@ -947,9 +948,8 @@ SCM_DEFINE (scm_mu_message_get_part, "mu-message-get-part", 2, 0, 0, ...@@ -947,9 +948,8 @@ SCM_DEFINE (scm_mu_message_get_part, "mu-message-get-part", 2, 0, 0,
947 948
948 SCM_DEFINE (scm_mu_message_send, "mu-message-send", 1, 3, 0, 949 SCM_DEFINE (scm_mu_message_send, "mu-message-send", 1, 3, 0,
949 (SCM MESG, SCM MAILER, SCM FROM, SCM TO), 950 (SCM MESG, SCM MAILER, SCM FROM, SCM TO),
950 "Sends the message MESG. Optional MAILER overrides default\n" 951 "Sends the message MESG. Optional MAILER overrides default mailer settings\n"
951 "mailer settings in mu-mailer.\n" 952 "in mu-mailer. Optional FROM and TO give sender and recever addresses.\n")
952 "Optional FROM and TO are sender and recever addresses\n")
953 #define FUNC_NAME s_scm_mu_message_send 953 #define FUNC_NAME s_scm_mu_message_send
954 { 954 {
955 const char *mailer_name; 955 const char *mailer_name;
......
...@@ -90,7 +90,9 @@ mu_scm_is_mime (SCM scm) ...@@ -90,7 +90,9 @@ mu_scm_is_mime (SCM scm)
90 90
91 SCM_DEFINE (scm_mu_mime_create, "mu-mime-create", 0, 2, 0, 91 SCM_DEFINE (scm_mu_mime_create, "mu-mime-create", 0, 2, 0,
92 (SCM FLAGS, SCM MESG), 92 (SCM FLAGS, SCM MESG),
93 "Creates a new MIME object.") 93 "Creates a new @acronym{MIME} object. Both arguments are optional.\n"
94 "FLAGS specifies the type of the object to create (@samp{0} is a reasonable\n"
95 "value). MESG gives the message to create the @acronym{MIME} object from.")
94 #define FUNC_NAME s_scm_mu_mime_create 96 #define FUNC_NAME s_scm_mu_mime_create
95 { 97 {
96 mu_message_t msg = NULL; 98 mu_message_t msg = NULL;
...@@ -126,7 +128,7 @@ SCM_DEFINE (scm_mu_mime_create, "mu-mime-create", 0, 2, 0, ...@@ -126,7 +128,7 @@ SCM_DEFINE (scm_mu_mime_create, "mu-mime-create", 0, 2, 0,
126 128
127 SCM_DEFINE (scm_mu_mime_multipart_p, "mu-mime-multipart?", 1, 0, 0, 129 SCM_DEFINE (scm_mu_mime_multipart_p, "mu-mime-multipart?", 1, 0, 0,
128 (SCM MIME), 130 (SCM MIME),
129 "Returns #t if MIME is a multipart object.\n") 131 "Returns @code{#t} if MIME is a multipart object.\n")
130 #define FUNC_NAME s_scm_mu_mime_multipart_p 132 #define FUNC_NAME s_scm_mu_mime_multipart_p
131 { 133 {
132 SCM_ASSERT (mu_scm_is_mime (MIME), MIME, SCM_ARG1, FUNC_NAME); 134 SCM_ASSERT (mu_scm_is_mime (MIME), MIME, SCM_ARG1, FUNC_NAME);
...@@ -136,7 +138,7 @@ SCM_DEFINE (scm_mu_mime_multipart_p, "mu-mime-multipart?", 1, 0, 0, ...@@ -136,7 +138,7 @@ SCM_DEFINE (scm_mu_mime_multipart_p, "mu-mime-multipart?", 1, 0, 0,
136 138
137 SCM_DEFINE (scm_mu_mime_get_num_parts, "mu-mime-get-num-parts", 1, 0, 0, 139 SCM_DEFINE (scm_mu_mime_get_num_parts, "mu-mime-get-num-parts", 1, 0, 0,
138 (SCM MIME), 140 (SCM MIME),
139 "Returns number of parts in a MIME object.") 141 "Returns number of parts in the @sc{mime} object MIME.")
140 #define FUNC_NAME s_scm_mu_mime_get_num_parts 142 #define FUNC_NAME s_scm_mu_mime_get_num_parts
141 { 143 {
142 mu_mime_t mime; 144 mu_mime_t mime;
...@@ -154,22 +156,22 @@ SCM_DEFINE (scm_mu_mime_get_num_parts, "mu-mime-get-num-parts", 1, 0, 0, ...@@ -154,22 +156,22 @@ SCM_DEFINE (scm_mu_mime_get_num_parts, "mu-mime-get-num-parts", 1, 0, 0,
154 #undef FUNC_NAME 156 #undef FUNC_NAME
155 157
156 SCM_DEFINE (scm_mu_mime_get_part, "mu-mime-get-part", 2, 0, 0, 158 SCM_DEFINE (scm_mu_mime_get_part, "mu-mime-get-part", 2, 0, 0,
157 (SCM MIME, SCM PART), 159 (SCM MIME, SCM NUM),
158 "Returns part number PART from a MIME object.") 160 "Returns NUMth part from the @sc{mime} object MIME.")
159 #define FUNC_NAME s_scm_mu_mime_get_part 161 #define FUNC_NAME s_scm_mu_mime_get_part
160 { 162 {
161 mu_message_t msg = NULL; 163 mu_message_t msg = NULL;
162 int status; 164 int status;
163 165
164 SCM_ASSERT (mu_scm_is_mime (MIME), MIME, SCM_ARG1, FUNC_NAME); 166 SCM_ASSERT (mu_scm_is_mime (MIME), MIME, SCM_ARG1, FUNC_NAME);
165 SCM_ASSERT (scm_is_integer (PART), PART, SCM_ARG2, FUNC_NAME); 167 SCM_ASSERT (scm_is_integer (NUM), NUM, SCM_ARG2, FUNC_NAME);
166 168
167 status = mu_mime_get_part (mu_scm_mime_get (MIME), 169 status = mu_mime_get_part (mu_scm_mime_get (MIME),
168 scm_to_int32 (PART), &msg); 170 scm_to_int32 (NUM), &msg);
169 if (status) 171 if (status)
170 mu_scm_error (FUNC_NAME, status, 172 mu_scm_error (FUNC_NAME, status,
171 "Cannot get part ~A from MIME object ~A", 173 "Cannot get part ~A from MIME object ~A",
172 scm_list_2 (PART, MIME)); 174 scm_list_2 (NUM, MIME));
173 175
174 return mu_scm_message_create (MIME, msg); 176 return mu_scm_message_create (MIME, msg);
175 } 177 }
...@@ -177,7 +179,7 @@ SCM_DEFINE (scm_mu_mime_get_part, "mu-mime-get-part", 2, 0, 0, ...@@ -177,7 +179,7 @@ SCM_DEFINE (scm_mu_mime_get_part, "mu-mime-get-part", 2, 0, 0,
177 179
178 SCM_DEFINE (scm_mu_mime_add_part, "mu-mime-add-part", 2, 0, 0, 180 SCM_DEFINE (scm_mu_mime_add_part, "mu-mime-add-part", 2, 0, 0,
179 (SCM MIME, SCM MESG), 181 (SCM MIME, SCM MESG),
180 "Adds MESG to the MIME object.") 182 "Adds MESG to the @sc{mime} object MIME.")
181 #define FUNC_NAME s_scm_mu_mime_add_part 183 #define FUNC_NAME s_scm_mu_mime_add_part
182 { 184 {
183 mu_mime_t mime; 185 mu_mime_t mime;
...@@ -203,7 +205,7 @@ SCM_DEFINE (scm_mu_mime_add_part, "mu-mime-add-part", 2, 0, 0, ...@@ -203,7 +205,7 @@ SCM_DEFINE (scm_mu_mime_add_part, "mu-mime-add-part", 2, 0, 0,
203 205
204 SCM_DEFINE (scm_mu_mime_get_message, "mu-mime-get-message", 1, 0, 0, 206 SCM_DEFINE (scm_mu_mime_get_message, "mu-mime-get-message", 1, 0, 0,
205 (SCM MIME), 207 (SCM MIME),
206 "Converts MIME object to a message.\n") 208 "Converts @sc{mime} object MIME to a message.\n")
207 #define FUNC_NAME s_scm_mu_mime_get_message 209 #define FUNC_NAME s_scm_mu_mime_get_message
208 { 210 {
209 mu_mime_t mime; 211 mu_mime_t mime;
......
...@@ -114,16 +114,20 @@ register_format (const char *name) ...@@ -114,16 +114,20 @@ register_format (const char *name)
114 114
115 SCM_DEFINE (scm_mu_register_format, "mu-register-format", 0, 0, 1, 115 SCM_DEFINE (scm_mu_register_format, "mu-register-format", 0, 0, 1,
116 (SCM REST), 116 (SCM REST),
117 "Registers desired mailutils formats. Takes any number of arguments.\n" 117 "Registers desired mailutils formats. Any number of arguments can be given.\n"
118 "Allowed arguments are:\n" 118 "Each argument must be one of the following strings:\n\n"
119 " \"mbox\" Regular UNIX mbox format\n" 119 "@multitable @columnfractions 0.3 0.6\n"
120 " \"mh\" MH mailbox format\n" 120 "@headitem Argument @tab Meaning\n"
121 " \"pop\" POP mailbox format\n" 121 "@item @samp{mbox} @tab Regular UNIX mbox format\n"
122 " \"imap\" IMAP mailbox format\n" 122 "@item @samp{mh} @tab @acronym{MH} mailbox format\n"
123 " \"sendmail\" sendmail mailer\n" 123 "@item @samp{maildir} @tab @i{Maildir} mailbox format\n"
124 " \"smtp\" smtp mailer\n" 124 "@item @samp{pop} @tab @acronym{POP} mailbox format\n"
125 "@item @samp{imap} @tab @acronym{IMAP} mailbox format\n"
126 "@item @samp{sendmail} @tab @i{sendmail} mailer format\n"
127 "@item @samp{smtp} @tab @acronym{SMTP} mailer format\n"
128 "@end multitable\n"
125 "\n" 129 "\n"
126 "If called without arguments, registers all available formats\n") 130 "If called without arguments, the function registers all available formats\n")
127 #define FUNC_NAME s_scm_mu_register_format 131 #define FUNC_NAME s_scm_mu_register_format
128 { 132 {
129 int status; 133 int status;
......
...@@ -20,11 +20,12 @@ ...@@ -20,11 +20,12 @@
20 20
21 SCM_DEFINE (scm_mu_getpwuid, "mu-getpwuid", 1, 0, 0, 21 SCM_DEFINE (scm_mu_getpwuid, "mu-getpwuid", 1, 0, 0,
22 (SCM USER), 22 (SCM USER),
23 "Look up an entry in the user database. USER can be an integer,\n" 23 "Look up an entry in the user database. USER can be an integer,\n"
24 "or a string, giving the behaviour of mu_get_auth_by_uid or mu_get_auth_by_name\n" 24 "or a string, giving the behaviour of @code{mu_get_auth_by_uid} or\n"
25 "respectively.\n" 25 "@code{mu_get_auth_by_name} respectively.\n"
26 "Returns a vector with fields corresponding to those of the mu_auth_data\n" 26 "\n"
27 "entry in question. If no matching entry was found, returns #f.\n") 27 "Returns a vector with fields corresponding to those of the @code{mu_auth_data}\n"
28 "entry in question. If no matching entry was found, returns @code{#f}.\n")
28 #define FUNC_NAME s_scm_mu_getpwuid 29 #define FUNC_NAME s_scm_mu_getpwuid
29 { 30 {
30 SCM result; 31 SCM result;
......