Add a doxygen config file.

[nmh] / h / prototypes.h

diff --git a/h/prototypes.h b/h/prototypes.h
index 7a4f8a382ed9bfa91cb4950a77d8df55cd99dfaf..4e1aefea0eb8d7e327e9518b4fb2774952c46d7c 100644 (file)
--- a/h/prototypes.h
+++ b/h/prototypes.h
@@ -29,6 +29,18 @@ void arglist_free (char *, char **);
 void ambigsw (char *, struct swit *);
 int atooi(char *);
 char **brkstring (char *, char *, char *);
 void ambigsw (char *, struct swit *);
 int atooi(char *);
 char **brkstring (char *, char *, char *);

+
+/*
+ * Check to see if we can display a given character set natively.
+ * Arguments include:
+ *
+ * str - Name of character set to check against
+ * len - Length of "str"
+ *
+ * Returns 1 if the specified character set can be displayed natively,
+ * 0 otherwise.
+ */
+

 int check_charset (char *, int);
 int client(char *, char *, char *, int, int);
 void closefds(int);
 int check_charset (char *, int);
 int client(char *, char *, char *, int, int);
 void closefds(int);


@@ -111,7 +123,15 @@ char **getans_via_readline (char *, struct swit *);
 #endif /* READLINE_SUPPORT */
 int getanswer (char *);
 char **getarguments (char *, int, char **, int);
 #endif /* READLINE_SUPPORT */
 int getanswer (char *);
 char **getarguments (char *, int, char **, int);

+
+/*
+ * Returns the MIME character set indicated by the current locale setting.
+ * Should be used by routines that want to convert to/from the local
+ * character set, or if you want to check to see if you can display content
+ * in the local character set.
+ */

 char *get_charset(void);
 char *get_charset(void);

+

 char *getcpy (const char *);
 char *get_default_editor(void);
 char *getfolder(int);
 char *getcpy (const char *);
 char *get_default_editor(void);
 char *getfolder(int);


@@ -178,16 +198,17 @@ int get_term_numcap(char *capability);
  *
  * Files opened for reading are locked with a read lock (if possible by
  * the underlying lock mechanism), files opened for writing are locked
  *
  * Files opened for reading are locked with a read lock (if possible by
  * the underlying lock mechanism), files opened for writing are locked

- * using an exclusive lock.
+ * using an exclusive lock.  The int * argument is used to indicate failure
+ * to acquire a lock.

  */
 int lkclosedata(int, const char *);
 int lkclosespool(int, const char *);
 int lkfclosedata(FILE *, const char *);
 int lkfclosespool(FILE *, const char *);
  */
 int lkclosedata(int, const char *);
 int lkclosespool(int, const char *);
 int lkfclosedata(FILE *, const char *);
 int lkfclosespool(FILE *, const char *);

-FILE *lkfopendata(const char *, const char *);
-int lkopendata(const char *, int, mode_t);
+FILE *lkfopendata(const char *, const char *, int *);
+int lkopendata(const char *, int, mode_t, int *);

 FILE *lkfopenspool(const char *, const char *);
 FILE *lkfopenspool(const char *, const char *);

-int lkopenspool(const char *, int, mode_t);
+int lkopenspool(const char *, int, mode_t, int *);

 int m_atoi (char *);
 char *m_backup (char *);
 int m_convert (struct msgs *, char *);
 int m_atoi (char *);
 char *m_backup (char *);
 int m_convert (struct msgs *, char *);


@@ -297,8 +318,12 @@ void seq_printall (struct msgs *);
  *               and a pointer to the filehandle will be stored in
  *               folder structure, where it will later be used by
  *               seq_save().
  *               and a pointer to the filehandle will be stored in
  *               folder structure, where it will later be used by
  *               seq_save().

+ *
+ * Return values:
+ *     OK       - successfully read the sequence files, or they don't exist
+ *     NOTOK    - failed to lock sequence file

  */
  */

-void seq_read (struct msgs * mp, int lockflag);
+int seq_read (struct msgs * mp, int lockflag);

 void seq_save (struct msgs *);
 void seq_setcur (struct msgs *, int);
 void seq_setprev (struct msgs *);
 void seq_save (struct msgs *);
 void seq_setcur (struct msgs *, int);
 void seq_setprev (struct msgs *);


@@ -362,6 +387,11 @@ int unputenv (char *);
 void unquote_string(const char *input, char *output);
 int uprf (char *, char *);
 int vfgets (FILE *, char **);
 void unquote_string(const char *input, char *output);
 int uprf (char *, char *);
 int vfgets (FILE *, char **);

+
+/*
+ * Output the local character set name, but make sure it is suitable for
+ * 8-bit characters.
+ */

 char *write_charset_8bit (void);
 
 
 char *write_charset_8bit (void);