Various small cleanups and documentation improvements.

[paraslash.git] / ggo.h

diff --git a/ggo.h b/ggo.h
index c9111b16503602f7fe4dc387e0d98023bfd7bdc5..4d452b1d294790ae8e426c0fdcee4a3d24c90813 100644 (file)
--- a/ggo.h
+++ b/ggo.h
@@ -1,7 +1,20 @@
+/*
+ * Copyright (C) 2008-2009 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file ggo.h Functions and structures for help text handling. */
+
+/**
+ * Used by exexutables that can not use gengetopt's generated help function.
+ */

 struct ggo_help {
 struct ggo_help {

+       /** The lines of the short help text. */

        const char **short_help;
        const char **short_help;

+       /** The lines of the detailed help text. */

        const char **detailed_help;
 };
 
 void ggo_print_help(struct ggo_help *help, int detailed_help);
        const char **detailed_help;
 };
 
 void ggo_print_help(struct ggo_help *help, int detailed_help);

-void printf_or_die(const char *fmt, ...);
+__printf_1_2 void printf_or_die(const char *fmt, ...);