From 5435f60f31e1704957c1e4abca569f807bb445fd Mon Sep 17 00:00:00 2001 From: Aaron Gyes Date: Sun, 12 Jun 2016 11:19:44 -0700 Subject: Improve comments, update Doxyfile Some changes were cribbed from #1317 --- Doxyfile | 6 +++--- src/wgetopt.h | 18 ++++++++++-------- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/Doxyfile b/Doxyfile index cf025f1b..21bd8db6 100644 --- a/Doxyfile +++ b/Doxyfile @@ -289,7 +289,7 @@ TCL_SUBST = # members will be omitted, etc. # The default value is: NO. -OPTIMIZE_OUTPUT_FOR_C = YES +OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored @@ -822,7 +822,7 @@ INPUT_ENCODING = UTF-8 # *.qsf, *.as and *.js. FILE_PATTERNS = *.h \ - *.c + *.cpp # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -837,7 +837,7 @@ RECURSIVE = NO # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = print_help.c +EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/src/wgetopt.h b/src/wgetopt.h index 5cf60ea0..f0b86f69 100644 --- a/src/wgetopt.h +++ b/src/wgetopt.h @@ -4,15 +4,17 @@ // is not usually useful since the argv array is always defined to be of type char**, but in fish, // all internal commands use wide characters and hence this library is useful. // -// If you want to use this version of getopt in your program, download the fish sourcecode, -// available at the fish homepage. Extract the sourcode, copy -// wgetopt.c and wgetopt.h into your program directory, include wgetopt.h in your program, and use -// all the regular getopt functions, prefixing every function, global variable and structure with a -// 'w', and use only wide character strings. There are no other functional changes in this version -// of getopt besides using wide character strings. +// If you want to use this version of getopt in your program, +// 1. Download the fish sourcecode, available at http://fishshell.com +// 2. Extract the sourcode +// 3. Copy wgetopt.cpp and wgetopt.h into your program directory, +// 4. #include wgetopt.h in your program +// 5. Make use of all the regular getopt functions, prefixing every function, global variable +// and d structure with a 'w', and use only wide character strings. +// There are no other functional changes in this version of getopt besides using wide character strings. // -// For examples of how to use wgetopt, see the fish builtin functions, many of which are defined in -// builtin.c. +// For examples of how to use wgetopt, see the fish builtin functions, which are defined in +// src/builtin_*.cpp /* Declarations for getopt. Copyright (C) 1989, 90, 91, 92, 93, 94 Free Software Foundation, Inc. -- cgit v1.2.3