github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-22 14:43:55 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve comments, update Doxyfile

Browse Source 
Some changes were cribbed from #1317
This commit is contained in:
Aaron Gyes 2016-06-12 11:19:44 -07:00
parent b72ed1fa8c
commit 5435f60f31
2 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doxyfile
View File

@ -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

18
src/wgetopt.h
View File

@ -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.