A little doxygen tidy-up

[disorder] / lib / wstat.c

diff --git a/lib/wstat.c b/lib/wstat.c
index 6d4cd29b1470f6a8f4dab9dc5e474baa9eb64197..0ac2c17165493d292c3e9ca901adfedad17d8d3f 100644 (file)
--- a/lib/wstat.c
+++ b/lib/wstat.c
@@ -1,28 +1,26 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004 Richard Kettlewell
+ * Copyright (C) 2004, 2007-2009 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * This program 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 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- *
- * This program 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.
- *
+ * 
+ * This program 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 this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @file lib/wstat.c
+ * @brief Convert wait status to text
  */
 
-#include <config.h>
+#include "common.h"
 
-#include <sys/wait.h>
-#include <stdio.h>
-#include <string.h>
 #include <signal.h>
 
 #include "mem.h"
@@ -30,7 +28,11 @@
 #include "wstat.h"
 #include "printf.h"
 
-const char *wstat(int w) {
+/** @brief Convert exit status to text
+ * @param w Exit status (e.g. from waitpid())
+ * @return Allocated string containing description of status
+ */
+char *wstat(int w) {
   int n;
   char *r;
 
@@ -46,7 +48,7 @@ const char *wstat(int w) {
   else
     n = byte_xasprintf(&r, "terminated with unknown wait status %#x",
                      (unsigned)w);
-  return n >= 0 ? r : "[could not convert wait status]";
+  return n >= 0 ? r : xstrdup("[could not convert wait status]");
 }
 
 /*