disorder.h: more consistent approach to function attributes

[disorder] / lib / client-common.h

diff --git a/lib/client-common.h b/lib/client-common.h
index dc50ee99c97ec52e8bfd10a6a2e55e1fedc46352..dd53a1d655e3d982f46b8bb70cac93c39dca5bff 100644 (file)
--- a/lib/client-common.h
+++ b/lib/client-common.h
@@ -1,30 +1,45 @@
 /*
  * This file is part of DisOrder
- * Copyright (C) 2004-2007 Richard Kettlewell
+ * Copyright (C) 2004-8, 2011, 2013 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/client-common.h
+ * @brief Common code to client APIs
  */
 
 #ifndef CLIENT_COMMON_H
 #define CLIENT_COMMON_H
 
 #include <sys/types.h>
-#include <sys/socket.h>
+#if HAVE_SYS_SOCKET_H
+# include <sys/socket.h>
+#endif
+
+socklen_t find_server(struct config *c, struct sockaddr **sap, char **namep);
+
+/** @brief Marker for a command body */
+extern const char disorder__body[1];
+
+/** @brief Marker for a list of args */
+extern const char disorder__list[1];
+
+/** @brief Marker for an integer */
+extern const char disorder__integer[1];
 
-socklen_t find_server(struct sockaddr **sap, char **namep);
+/** @brief Marker for a timestamp */
+extern const char disorder__time[1];
 
 #endif /* CLIENT_COMMON_H */