Comment fix to make Doxygen happy

[yaz-moved-to-github.git] / include / yaz / options.h

diff --git a/include/yaz/options.h b/include/yaz/options.h
index 6fd9cd3..79c229e 100644 (file)
--- a/include/yaz/options.h
+++ b/include/yaz/options.h
@@ -1,5 +1,5 @@
-/*
- * Copyright (c) 1995-2008, Index Data
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2012 Index Data.
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -24,7 +24,6 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/* $Id: options.h,v 1.9 2008-02-20 10:03:42 adam Exp $ */
 
 /**
  * \file options.h
@@ -32,13 +31,13 @@
  */
 
 #ifndef YAZ_OPTIONS_H
-#define TAZ_OPTIONS_H
+#define YAZ_OPTIONS_H
 #include <yaz/yconfig.h>
 
 YAZ_BEGIN_CDECL
 
 
-/** \brief parser command-line options
+/** \brief command-line options parsing for main
     \arg desc command argument description (allowed options)
     \arg argv main argv
     \arg argc main argc
@@ -56,8 +55,11 @@ YAZ_BEGIN_CDECL
     The first char is what is returned when met (single char option char).
     The second is zero ore more long option values (synonum for single char)
     If colon is appended, it means the option takes an argument.
+    If argv includes empty long option (--) that means "end of options" :
+    all argv data following that is considered non-options .. (0 returned
+    for each).
 */
-YAZ_EXPORT int options (const char *desc, char **argv, int argc, char **arg);
+YAZ_EXPORT int options(const char *desc, char **argv, int argc, char **arg);
 
 #define YAZ_OPTIONS_ERROR (-1)
 #define YAZ_OPTIONS_EOF (-2)
@@ -69,6 +71,7 @@ YAZ_END_CDECL
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab