aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorGravatar Aaron Gyes <me@aaron.gy>2016-06-12 11:19:44 -0700
committerGravatar Aaron Gyes <me@aaron.gy>2016-06-12 11:19:44 -0700
commit5435f60f31e1704957c1e4abca569f807bb445fd (patch)
tree881429ad906d78653fc84d3ba79f6256cacd0a4f /src
parentb72ed1fa8c7b44c6cacf0da9348d2c0d10f5ca70 (diff)
Improve comments, update Doxyfile
Some changes were cribbed from #1317
Diffstat (limited to 'src')
-rw-r--r--src/wgetopt.h18
1 files changed, 10 insertions, 8 deletions
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 <a href='http://fishshell.com'>the fish homepage</a>. 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.