";
-/** @} */
static const char *fix_attr_value(const char *);
-/**
+/*
* print string and new line.
*
- * This function is a replacement of @CODE{fprintf(op, \"\%s\\n\", s)} in @NAME{htags}.
+ * This function is a replacement of fprintf(op, "%s\n", s) in htags.
*/
int
fputs_nl(const char *s, FILE *op)
@@ -158,14 +152,12 @@
putc('\n', op);
return 0;
}
-/**
- * @name These methods is used to tell lex() the current path infomation.
+/*
+ * These methods is used to tell lex() the current path infomation.
*/
-/** @{ */
static char current_path[MAXPATHLEN];
static char current_dir[MAXPATHLEN];
static char current_file[MAXPATHLEN];
-/** @} */
/**
* save path infomation
@@ -204,7 +196,7 @@
/**
* Generate upper directory.
*
- * Just returns the parent path of @a dir. (Adds @FILE{../} to it).
+ * Just returns the parent path of dir. (Adds "../" to it).
*/
const char *
upperdir(const char *dir)
@@ -215,10 +207,10 @@
strbuf_sprintf(sb, "../%s", dir);
return strbuf_value(sb);
}
-/**
- * Load text from file with replacing @address@hidden@} macro.
- * Macro @address@hidden@} is replaced with the parent directory
- * of the @FILE{HTML} directory.
+/*
+ * Load text from file with replacing @PARENT_DIR@ macro.
+ * Macro @PARENT_DIR@ is replaced with the parent directory
+ * of the "HTML" directory.
*/
static const char *
sed(FILE *ip, int place)
@@ -291,8 +283,8 @@
* Generate beginning of generic page
*
* @param[in] title title of this page
- * @param[in] place #SUBDIR: this page is in sub directory
- * #TOPDIR: this page is in the top directory
+ * @param[in] place SUBDIR: this page is in sub directory,
+ * TOPDIR: this page is in the top directory
* @param[in] use_frameset
* use frameset document type or not
* @param[in] header_item
@@ -349,8 +341,8 @@
* Generate beginning of normal page
*
* @param[in] title title of this page
- * @param[in] place #SUBDIR: this page is in sub directory
- * #TOPDIR: this page is in the top directory
+ * @param[in] place SUBDIR: this page is in sub directory,
+ * TOPDIR: this page is in the top directory
*/
const char *
gen_page_begin(const char *title, int place)
@@ -368,8 +360,8 @@
{
return gen_page_generic_begin(title, TOPDIR, 0, header_item);
}
-/**
- * Generate beginning of frameset page (@CODE{\})
+/*
+ * Generate beginning of frameset page ()
*/
const char *
gen_frameset_end(void)
{
return "";
}
-/**
- * Generate beginning of frame (@CODE{\})
+/*
+ * Generate beginning of frame ()
*
- * @param[in] name target (value for @CODE{name} and @CODE{id} attributes)
- * @param[in] src value for @CODE{src} attribute
+ * @param[in] name target (value for name and id attributes)
+ * @param[in] src value for src attribute
*/
const char *
gen_frame(const char *name, const char *src)
@@ -797,12 +786,12 @@
}
-/** HTML attribute delimiter character ( ' or " only) */
+/** HTML attribute delimiter character ( ' or " only) */
#define ATTR_DELIM '\''
-/**
- * Check and fix an attribute's value; convert all @c ' (single quote) characters
- * into @CODE{\&\#39;} within it.
+/*
+ * Check and fix an attribute's value; convert all ' (single quote) characters
+ * into ' within it.
*/
static const char *
fix_attr_value(const char *value)
diff -ur global-6.5-old/htags/common.h global-7.7-new/htags/common.h
--- global-6.5-old/htags/common.h 2015-06-10 02:45:07.000000000 +0100
+++ global-7.7-new/htags/common.h 2015-06-17 16:09:32.000000000 +0100
@@ -22,24 +22,18 @@
/*
* Parameter values.
*/
-/**
- * @name Defines for gen_image()
- * See: gen_image()
+/*
+ * Defines for gen_image()
*/
-/** @{ */
#define CURRENT 0
#define PARENT 1
-/** @} */
-/**
- * @name Defines for gen_page_begin()
- * See: gen_page_begin()
+/*
+ * Defines for gen_page_begin()
*/
-/** @{ */
#define TOPDIR 0
#define SUBDIR 1
#define CGIDIR 2
-/** @} */
/*
* tag
diff -ur global-6.5-old/htags/defineindex.c global-7.7-new/htags/defineindex.c
--- global-6.5-old/htags/defineindex.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags/defineindex.c 2015-06-17 16:08:17.000000000 +0100
@@ -36,12 +36,12 @@
#include "path2url.h"
#include "common.h"
-/**
+/*
* makedefineindex: make definition index (including alphabetic index)
*
* @param[in] file definition index file
* @param[in] total definitions total
- * @param[out] defines address@hidden
+ * @param[out] defines @defines
* @par Globals used (input):
* tag cache XXX: should this be global output, not input?
*/
diff -ur global-6.5-old/htags/fileindex.c global-7.7-new/htags/fileindex.c
--- global-6.5-old/htags/fileindex.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags/fileindex.c 2015-06-17 16:02:16.000000000 +0100
@@ -49,7 +49,7 @@
/**
* get a path from input stream.
*
- * @note Each path name must start with @CODE{"./"}.
+ * @note Each path name must start with "./".
*/
static const char *
getpath(void)
@@ -87,8 +87,8 @@
* extract_lastname: extract the last name of include line.
*
* @param[in] image source image of include
- * @param[in] is_php 1: is @NAME{PHP} source
- * @return last name or @VAR{NULL} on error.
+ * @param[in] is_php 1: is PHP source
+ * @return last name or NULL on error.
*/
static const char *
extract_lastname(const char *image, int is_php)
@@ -171,7 +171,7 @@
return NULL;
}
/**
- * get the last part of the @a path.
+ * get the last part of the path.
*
* @param[in] path path name
* @return last part
@@ -190,7 +190,7 @@
return p ? p + 1 : path;
}
/**
- * get the directory part of the @a path.
+ * get the directory part of the path.
*
* @param[in] path path name
* @param[out] result result buffer
@@ -213,11 +213,11 @@
return result;
}
/**
- * get the local path name if the path is under the @a dir.
+ * get the local path name if the path is under the dir.
*
* @param[in] path path name
* @param[in] dir directory name
- * @return local path name or @VAR{NULL}
+ * @return local path name or NULL
*
* @par Examples:
* @code
@@ -236,12 +236,12 @@
return NULL;
}
/**
- * append @CODE{'/'} after the path name
+ * append '/' after the path name
*
* @param[in] path path name
* @return appended path name
*
- * @note Doesn't check if ends with a @CODE{'/'} already.
+ * @note Doesn't check if ends with a '/' already.
*
* @par Examples:
* @code
@@ -259,7 +259,7 @@
return strbuf_value(sb);
}
/**
- * remove @CODE{"./"} at the head of the path name
+ * remove "./" at the head of the path name
*
* @param[in] path path name
* @return removed path name
@@ -333,7 +333,7 @@
/**
* @fn static int print_directory(int level, char *basedir)
*
- * print contents of one directory and the descendant. (@STRONG{recursively called})
+ * print contents of one directory and the descendant. (recursively called)
*
* @param[in] level directory nest level
* @param[in,out] basedir current directory
@@ -341,7 +341,7 @@
* This function read find style records, and print directory tree.
*/
/**
- * File list of the top level directory (when @CODE{level == 0}) is not written
+ * File list of the top level directory (when level == 0) is not written
* to a file directly. Instead, it is written to string buffer, because
* it appears in some places.
*/
diff -ur global-6.5-old/htags/htags.c global-7.7-new/htags/htags.c
--- global-6.5-old/htags/htags.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags/htags.c 2015-06-18 19:36:37.000000000 +0100
@@ -55,7 +55,7 @@
/**
* @file
- * @NAME{htags} - generate hypertext (XHTML or HTML) pages from a set of source files.
+ * htags - generate hypertext (XHTML or HTML) pages from a set of source files.
*/
void src2html(const char *, const char *, int);
@@ -98,41 +98,41 @@
* @details
* Order of items in the top page (This should be customisable variable in the future).
*
- * @CODE{'c'}: caution
- * @CODE{'s'}: search form
- * @CODE{'m'}: mains
- * @CODE{'d'}: definitions
- * @CODE{'f'}: files
- * @CODE{'t'}: call tree
+ * 'c': caution
+ * 's': search form
+ * 'm': mains
+ * 'd': definitions
+ * 'f': files
+ * 't': call tree
*/
char *item_order = "csmdft";
/*
* options
*/
-int aflag; /**< @OPTION{--alphabet(-a)} option */
-int fflag; /**< @OPTION{--form(-f)} option */
-int Fflag; /**< @OPTION{--frame(-F)} option */
-int gflag; /**< @OPTION{--gtags(-g)} option */
-int Iflag; /**< @OPTION{--icon(-I)} option */
-int nflag; /**< @OPTION{--line-number(-n)} option */
+int aflag; /**< --alphabet(-a) option */
+int fflag; /**< --form(-f) option */
+int Fflag; /**< --frame(-F) option */
+int gflag; /**< --gtags(-g) option */
+int Iflag; /**< --icon(-I) option */
+int nflag; /**< --line-number(-n) option */
int qflag;
-int vflag; /**< @OPTION{--verbose(-v)} option */
-int wflag; /**< @OPTION{--warning(-w)} option */
-int debug; /**< @OPTION{--debug} option */
-
-int show_help; /**< @OPTION{--help} command */
-int show_version; /**< @OPTION{--version} command */
-int caution; /**< @OPTION{--caution} option */
-int dynamic; /**< @OPTION{--dynamic(-D)} option */
-int symbol; /**< @OPTION{--symbol(-s)} option */
-int suggest; /**< @OPTION{--suggest} option */
-int suggest2; /**< @OPTION{--suggest2} option */
-int auto_completion; /**< @OPTION{--auto-completion} */
-int tree_view; /**< @OPTION{--tree-view} */
-int fixed_guide; /**< @OPTION{--fixed-guide} */
-const char *tree_view_type; /**< @OPTION{--type-view=[type]} */
-char *auto_completion_limit = "0"; /**< @OPTION{--auto-completion=limit} */
-int statistics = STATISTICS_STYLE_NONE; /**< @OPTION{--statistics} option */
+int vflag; /**< --verbose(-v) option */
+int wflag; /**< --warning(-w) option */
+int debug; /**< --debug option */
+
+int show_help; /**< --help command */
+int show_version; /**< --version command */
+int caution; /**< --caution option */
+int dynamic; /**< --dynamic(-D) option */
+int symbol; /**< --symbol(-s) option */
+int suggest; /**< --suggest option */
+int suggest2; /**< --suggest2 option */
+int auto_completion; /**< --auto-completion */
+int tree_view; /**< --tree-view */
+int fixed_guide; /**< --fixed-guide */
+const char *tree_view_type; /**< --type-view=[type] */
+char *auto_completion_limit = "0"; /**< --auto-completion=limit */
+int statistics = STATISTICS_STYLE_NONE; /**< --statistics option */
int no_order_list; /**< 1: doesn't use order list */
int other_files; /**< 1: list other files */
@@ -146,20 +146,18 @@
const char *cvsweb_cvsroot;
const char *gtagslabel;
const char *title;
-const char *insert_header; /**< @OPTION{--insert-header=\} */
-const char *insert_footer; /**< @OPTION{--insert-footer=\} */
-const char *html_header; /**< @OPTION{--html-header=\} */
+const char *insert_header; /* --insert-header= */
+const char *insert_footer; /* --insert-footer= */
+const char *html_header; /* --html-header= */
const char *jscode; /**< javascript code */
-/**
- * @name Constant values.
+/*
+ * Constant values.
*/
-/** @{ */
const char *title_define_index = "DEFINITIONS";
const char *title_file_index = "FILES";
const char *title_call_tree = "CALL TREE";
const char *title_callee_tree = "CALLEE TREE";
const char *title_included_from = "INCLUDED FROM";
-/** @} */
/*
* Function header items.
*/
@@ -229,10 +227,9 @@
"text",
"pglobe"
};
-/**
- * @name Configuration parameters.
+/*
+ * Configuration parameters.
*/
-/** @{ */
int ncol = 4; /**< columns of line number */
int tabs = 8; /**< tab skip */
int flist_fields = 5; /**< fields number of file list */
@@ -257,7 +254,6 @@
const char *include_file_suffixes = DEFAULTINCLUDEFILESUFFIXES; /**< include_file_suffixes */
static const char *langmap = DEFAULTLANGMAP; /**< langmap */
int grtags_is_empty = 0; /**< grtags_is_empty */
-/** @} */
static struct option const long_options[] = {
/*
@@ -376,7 +372,7 @@
/**
* Setup signal hander.
*
- * Makes signals @CODE{SIGINT}, @CODE{SIGTERM}, @CODE{SIGHUP} and @CODE{SIGQUIT}
+ * Makes signals SIGINT, SIGTERM, SIGHUP and SIGQUIT
* call suddenly() if triggered.
*/
static void
@@ -393,13 +389,13 @@
}
/**
- * make directory in the dist (#distpath) directory.
+ * make directory in the dist (distpath) directory.
*
* @param[in] name name of directory to create.
*
- * Creates a file called @FILE{index.html} in the new directory.
+ * Creates a file called "index.html" in the new directory.
*
- * @remark @NAME{mkdir()} creates the directory in mode @CODE{0775}, if doesn't exist.
+ * @remark mkdir() creates the directory in mode 0775, if doesn't exist.
*/
static void
make_directory_in_distpath(const char *name)
@@ -423,7 +419,7 @@
fclose(op);
}
/**
- * make file in the dist (#distpath) directory.
+ * make file in the dist (distpath) directory.
*/
static void
make_file_in_distpath(const char *name, const char *data)
@@ -561,7 +557,7 @@
*
* @param[in] dist directory where the file should be created
* @param[in] file file name
- * @param[in] place #TOPDIR, #SUBDIR, #CGIDIR
+ * @param[in] place TOPDIR, SUBDIR, CGIDIR
*/
static void
generate_file(const char *dist, const char *file, int place)
@@ -579,7 +575,7 @@
strbuf_close(result);
}
/**
- * makeprogram: make @NAME{CGI} program
+ * makeprogram: make CGI program
*/
static void
makeprogram(const char *cgidir, const char *file)
@@ -673,10 +669,10 @@
fclose(op);
html_count++;
}
-/**
+/*
* makesearchpart: make search part
*
- * @param[in] target \$target
+ * @param[in] target $target
* @return html
*/
static char *
@@ -835,7 +831,7 @@
html_count++;
}
/**
- * makehtaccess: make @FILE{.htaccess} skeleton file.
+ * makehtaccess: make ".htaccess" skeleton file.
*/
static void
makehtaccess(const char *cgidir, const char *file)
@@ -951,7 +947,7 @@
load_with_replace(file, result, 0);
}
/**
- * makecommonpart: make a common part for @FILE{mains.html} and @FILE{index.html}
+ * makecommonpart: make a common part for "mains.html" and "index.html"
*
* @param[in] title
* @param[in] defines
@@ -1143,7 +1139,7 @@
* load configuration variables.
*/
static void
-configuration()
+configuration(void)
{
STRBUF *sb = strbuf_open(0);
char *p, *q;
diff -ur global-6.5-old/htags/htags.h global-7.7-new/htags/htags.h
--- global-6.5-old/htags/htags.h 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags/htags.h 2015-06-17 16:06:24.000000000 +0100
@@ -38,27 +38,23 @@
#define PQUOTE
#endif
-/**
- * @name definition_header
+/*
+ * definition_header
*/
-/** @{ */
#define NO_HEADER 0
#define BEFORE_HEADER 1
#define RIGHT_HEADER 2
#define AFTER_HEADER 3
-/** @} */
-/**
- * @name Directory names.
+/*
+ * Directory names.
*/
-/** @{ */
#define SRCS "S"
#define DEFS "D"
#define REFS "R"
#define INCS "I"
#define INCREFS "J"
#define SYMS "Y"
-/** @} */
extern int w32;
extern const char *www;
diff -ur global-6.5-old/htags/incop.c global-7.7-new/htags/incop.c
--- global-6.5-old/htags/incop.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags/incop.c 2015-06-17 16:05:36.000000000 +0100
@@ -66,7 +66,7 @@
/**
* put_inc: put include file.
*
- * @param[in] file file name (the last component of the @a path)
+ * @param[in] file file name (the last component of the path)
* @param[in] path path name or command line.
* @param[in] id path id
*/
diff -ur global-6.5-old/htags/lexcommon.h global-7.7-new/htags/lexcommon.h
--- global-6.5-old/htags/lexcommon.h 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags/lexcommon.h 2015-06-17 15:54:10.000000000 +0100
@@ -23,18 +23,17 @@
#include "tab.h"
/**
- * @name Definition of LEXTEXT, LEXLENG, LEXIN and LEXRESTART.
+ * Definition of LEXTEXT, LEXLENG, LEXIN and LEXRESTART.
*
- * These symbols are substitutions of @CODE{yytext}, @CODE{yyleng}, @CODE{yyin} and @CODE{yyrestart}.
- * You should write @NAME{lex} code using them.
- * The usage of this file is, for instance, in @FILE{c.l}:
+ * These symbols are substitutions of yytext, yyleng, yyin and yyrestart.
+ * You should write lex code using them.
+ * The usage of this file is, for instance, in "c.l":
*
* @code
* #define lex_symbol_generation_rule(x) c_ ## x
* #include "lexcommon.h"
* @endcode
*/
-/** @{ */
#ifndef lex_symbol_generation_rule
ERROR: lex_symbol_generation_rule(x) macro not defined.
lexcommon.h requires the lex_symbol_generation_rule(x) macro for each language
@@ -44,33 +43,27 @@
#define LEXLENG lex_symbol_generation_rule(leng)
#define LEXIN lex_symbol_generation_rule(in)
#define LEXRESTART lex_symbol_generation_rule(restart)
-/** @} */
-/**
- * @name
+/*
* The default action for line control.
- * These can be applicable to most languages.
- * You must define @VAR{C_COMMENT}, @VAR{CPP_COMMENT} @VAR{SHELL_COMMENT}, @VAR{LITERAL}, @VAR{STRING}
- * and @VAR{PREPROCESSOR_LINE} as @CODE{\%start} values, even if they are not used.
- * It assumed that @VAR{CPP_COMMENT} and @VAR{SHELL_COMMENT} is one line comment.
+ * These can be applicable to most languages.
+ * You must define C_COMMENT, CPP_COMMENT, SHELL_COMMENT, LITERAL, STRING
+ * and PREPROCESSOR_LINE as %start values, even if they are not used.
+ * It assumed that CPP_COMMENT and SHELL_COMMENT is one line comment.
*/
-/** @{ */
static int lexcommon_lineno;
static int begin_line;
-/** @} */
/**
* If you want newline to terminate string, set this variable to 1.
*/
static int newline_terminate_string = 0;
-/**
- * @name Variables for converting tabs to spaces.
+/*
+ * Variables for converting tabs to spaces.
*/
-/** @{ */
static int dest_column;
static int left_spaces;
-/** @} */
#define YY_INPUT(buf, result, max_size) do { \
result = read_file_detabing(buf, max_size, LEXIN, \
diff -ur global-6.5-old/htags/path2url.c global-7.7-new/htags/path2url.c
--- global-6.5-old/htags/path2url.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags/path2url.c 2015-06-13 09:16:16.000000000 +0100
@@ -39,7 +39,7 @@
/**
* load_gpath: load gpath tag file.
*
- * load the contents of @NAME{GPATH} file into the memory.
+ * load the contents of GPATH file into the memory.
*/
void
load_gpath(const char *dbpath)
@@ -67,7 +67,7 @@
/**
* unload_gpath: unload gpath tag file.
*
- * unload the contents of @NAME{GPATH} file from memory.
+ * unload the contents of GPATH file from memory.
*/
void
unload_gpath(void)
diff -ur global-6.5-old/htags/src2html.c global-7.7-new/htags/src2html.c
--- global-6.5-old/htags/src2html.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags/src2html.c 2015-06-18 19:37:46.000000000 +0100
@@ -41,13 +41,13 @@
/*----------------------------------------------------------------------*/
/**
* @details
- * This is the linkage section of each parsers.
- * If you want to support new language, you must define two procedures:
- * -# Initializing procedure (#init_proc).
+ * This is the linkage section of each parsers.
+ * If you want to support new language, you must define two procedures:
+ * 1. Initializing procedure (init_proc).
* Called once first with an input file descripter.
- * -# Executing procedure (#exec_proc).
- * Called repeatedly until returning @NAME{EOF}.
- * It should read from above descripter and write @NAME{HTML}
+ * 2. Executing procedure (exec_proc).
+ * Called repeatedly until returning EOF.
+ * It should read from above descripter and write HTML
* using output procedures in this module.
*/
struct lang_entry {
@@ -56,30 +56,24 @@
int (*exec_proc)(void); /**< executing procedure */
};
-/**
- * @name initializing procedures
- * For lang_entry::init_proc
+/*
+ * initializing procedures
*/
-/** @{ */
void c_parser_init(FILE *);
void yacc_parser_init(FILE *);
void cpp_parser_init(FILE *);
void java_parser_init(FILE *);
void php_parser_init(FILE *);
void asm_parser_init(FILE *);
-/** @} */
-/**
- * @name executing procedures
- * For lang_entry::exec_proc
+/*
+ * executing procedures
*/
-/** @{ */
int c_lex(void);
int cpp_lex(void);
int java_lex(void);
int php_lex(void);
int asm_lex(void);
-/** @} */
/**
* The first entry is default language.
@@ -98,10 +92,10 @@
/**
* get language entry.
*
- * If the specified language (@a lang) is not found, it assumes the
- * default language, which is @NAME{C}.
+ * If the specified language (lang) is not found, it assumes the
+ * default language, which is C.
*
- * @param[in] lang language name (@VAR{NULL} means 'not specified'.)
+ * @param[in] lang language name (NULL means 'not specified'.)
* @return language entry
*/
static struct lang_entry *
@@ -138,13 +132,13 @@
static int warned;
static int last_lineno;
-/**
+/*
* Put a character to HTML as is.
*
- * @note You should use this function to put a control character.
+ * @note You should use this function to put a control character.
*
* @attention
- * No escaping of @CODE{'\<'}, @CODE{'\>'} and @CODE{'\&'} is performed.
+ * No escaping of '<', '>' and '&' is performed.
*
* @see put_char()
*/
@@ -153,13 +147,13 @@
{
strbuf_putc(outbuf, c);
}
-/**
+/*
* Put a string to HTML as is.
*
* @note You should use this function to put a control sequence.
*
* @attention
- * No escaping of @CODE{'\<'}, @CODE{'\>'} and @CODE{'\&'} is performed.
+ * No escaping of '<', '>' and '&' is performed.
*
* @see put_string()
*/
@@ -171,10 +165,10 @@
/*----------------------------------------------------------------------*/
/* HTML output */
/*----------------------------------------------------------------------*/
-/**
+/*
* Quote character with HTML's way.
*
- * (Fixes @CODE{'\<'}, @CODE{'\>'} and @CODE{'\&'} for HTML).
+ * (Fixes '<', '>' and '&' for HTML).
*/
static const char *
HTML_quoting(int c)
@@ -187,11 +181,11 @@
return quote_amp;
return NULL;
}
-/**
+/*
* fill_anchor: fill anchor into file name
*
- * @param[in] root \$root or index page
- * @param[in] path \$path name
+ * @param[in] root $root or index page
+ * @param[in] path $path name
* @return hypertext file name string
*/
const char *
@@ -231,7 +225,7 @@
/**
* link_format: make hypertext from anchor array.
*
- * @param[in] ref (previous, next, first, last, top, bottom)
+ * @param[in] ref (previous, next, first, last, top, bottom)
* -1: top, -2: bottom, other: line number
* @return HTML
*/
@@ -275,7 +269,7 @@
/**
* fixed_guide_link_format: make fixed guide
*
- * @param[in] ref (previous, next, first, last, top, bottom)
+ * @param[in] ref (previous, next, first, last, top, bottom)
* -1: top, -2: bottom, other: line number
* @param[in] anchors
* @return HTML
@@ -371,10 +365,10 @@
/**
* tooltip: generate tooltip string
*
- * @param[in] type @CODE{'I'}: 'Included from'
- * @CODE{'R'}: 'Defined at'
- * @CODE{'Y'}: 'Used at'
- * @CODE{'D'}, @CODE{'M'}: 'Referred from'
+ * @param[in] type 'I': 'Included from',
+ * 'R': 'Defined at',
+ * 'Y': 'Used at',
+ * 'D', 'M': 'Referred from'
* @param[in] lno line number
* @param[in] opt
* @return tooltip string
@@ -422,9 +416,9 @@
* put_anchor: output HTML anchor.
*
* @param[in] name tag
- * @param[in] type tag type. @CODE{'R'}: @NAME{GTAGS}
- * @CODE{'Y'}: @NAME{GSYMS}
- * @CODE{'D'}, @CODE{'M'}, @CODE{'T'}: @NAME{GRTAGS}
+ * @param[in] type tag type. 'R': GTAGS,
+ * 'Y': GSYMS,
+ * 'D', 'M', 'T': GRTAGS
* @param[in] lineno current line no
*/
void
@@ -515,7 +509,7 @@
* @param[in] length
* @param[in] lineno current line no
*
- * @remark The tag type is fixed at 'R' (@NAME{GTAGS})
+ * @remark The tag type is fixed at 'R' (GTAGS)
*/
void
put_anchor_force(char *name, int length, int lineno)
@@ -562,7 +556,7 @@
strbuf_puts(outbuf, gen_href_end());
}
/**
- * Put a reserved word (@CODE{if}, @CODE{while}, ...)
+ * Put a reserved word (if, while, ...)
*/
void
put_reserved_word(const char *word)
@@ -571,8 +565,8 @@
strbuf_puts(outbuf, word);
strbuf_puts(outbuf, reserved_end);
}
-/**
- * Put a macro (@CODE{\#define}, @CODE{\#undef}, ...)
+/*
+ * Put a macro (#define, #undef, ...)
*/
void
put_macro(const char *word)
@@ -603,7 +597,7 @@
warned = 1;
}
/**
- * Print warning message when unknown @NAME{yacc} directive is found.
+ * Print warning message when unknown yacc directive is found.
*/
void
unknown_yacc_directive(const char *word, int lineno)
@@ -622,10 +616,10 @@
if (colorize_warned_line)
warned = 1;
}
-/**
+/*
* Put a character with HTML quoting.
*
- * @note If you want to put @CODE{'\<'}, @CODE{'\>'} or @CODE{'\&'}, you
+ * @note If you want to put '<', '>' or '&', you
* should echoc() instead, as this function escapes (fixes) those
* characters for HTML.
*/
@@ -639,12 +633,12 @@
else
strbuf_putc(outbuf, c);
}
-/**
+/*
* Put a string with HTML quoting.
*
* @note If you want to put HTML tag itself, you should echos() instead,
- * as this function escapes (fixes) the characters @CODE{'\<'},
- * @CODE{'\>'} and @CODE{'\&'} for HTML.
+ * as this function escapes (fixes) the characters '<',
+ * '>' and '&' for HTML.
*/
void
put_string(const char *s)
@@ -653,7 +647,7 @@
put_char(*s);
}
/**
- * Put brace (@c '{', @c '}')
+ * Put brace ('{', '}')
*/
void
put_brace(const char *text)
@@ -663,13 +657,11 @@
strbuf_puts(outbuf, brace_end);
}
-/**
- * @name common procedure for line control.
+/*
+ * common procedure for line control.
*/
-/** @{ */
static char lineno_format[32];
static const char *guide = NULL;
-/** @} */
/**
* Begin of line processing.
@@ -693,9 +685,9 @@
*
* @param[in] lineno current line number
* @par Globals used (input):
- * @NAME{outbuf}, HTML line image
+ * outbuf, HTML line image
*
- * The @EMPH{outbuf} (string buffer) has HTML image of the line.
+ * The outbuf (string buffer) has HTML image of the line.
* This function flush and clear it.
*/
void
@@ -751,12 +743,12 @@
}
}
/**
- * get_cvs_module: return @NAME{CVS} module of source file.
+ * get_cvs_module: return CVS module of source file.
*
* @param[in] file source path
- * @param[out] basename If @a basename is not @CODE{NULL}, store pointer to
+ * @param[out] basename If basename is not NULL, store pointer to
* the last component of source path.
- * @return !=NULL : relative path from repository top
+ * @return !=NULL : relative path from repository top,
* ==NULL : CVS/Repository is not readable.
*/
static const char *
diff -ur global-6.5-old/htags-refkit/htags_path2url.c global-7.7-new/htags-refkit/htags_path2url.c
--- global-6.5-old/htags-refkit/htags_path2url.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/htags-refkit/htags_path2url.c 2015-06-17 16:28:42.000000000 +0100
@@ -24,11 +24,11 @@
int htags_path2url(const char *, int, char *, int);
/** @file
- * @NAME{htags} Hyper-text Reference Kit.
+ * htags Hyper-text Reference Kit.
*
* Usage by example.
*
- * Getting the URL of @FILE{i386/i386/identcpu.c} at 120, in variable url.
+ * Getting the URL of "i386/i386/identcpu.c" at 120, in variable url.
*
* @code
* char url[MAXPATHLEN];
@@ -58,17 +58,15 @@
const char *name;
const char *path;
};
-/**
- * @name Global variables.
+/*
+ * Global variables.
*
- * These variables are set by htags_load_filemap(), and referred by
+ * These variables are set by htags_load_filemap(), and referred by
* htags_path2url() and htags_unload_filemap().
*/
-/** @{ */
static char *global_contents; /**< filemap contents */
-static struct map *global_map; /**< file -\> url mapping table */
-static int global_maplines; /**< the lines of #global_map */
-/** @} */
+static struct map *global_map; /**< file -> url mapping table */
+static int global_maplines; /**< the lines of global_map */
/*----------------------------------------------------------------------*/
/* Local functions */
@@ -78,11 +76,11 @@
*
* @param[in] file path of FILEMAP
* @param[out] area file contents (malloced)
- * @param[out] size size of @a area
- * @return 0 succesful
- * -1: out of memory.
- * -2: FILEMAP not found.
- * -3: cannot fstat FILEMAP.
+ * @param[out] size size of area
+ * @return 0 succesful
+ * -1: out of memory.
+ * -2: FILEMAP not found.
+ * -3: cannot fstat FILEMAP.
* -4: cannot read FILEMAP.
*/
static int
@@ -119,7 +117,7 @@
}
/**
- * comparison function for @CODE{bsearch()}.
+ * comparison function for bsearch().
*/
static int
cmp(const void *s1, const void *s2)
@@ -130,11 +128,11 @@
* creates index for in core FILEMAP.
*
* @param[in] area filemap contents
- * @param[in] size size of @a area
+ * @param[in] size size of area
* @param[out] map map structure
- * @param[out] lines @a map lines
- * @return 0: succesful
- * -1: out of memory.
+ * @param[out] lines map lines
+ * @return 0: succesful
+ * -1: out of memory.
* -5: invalid format.
*/
static int
@@ -203,15 +201,15 @@
*
* @param[in] filemap FILEMAP file
* @par Globals used (output):
- * #global_contents filemap contents (for free)
- * #global_map filemap index.
- * #global_maplines lines of filemap index.
- *
- * @return 0: succesful
- * -1: out of memory.
- * -2: FILEMAP not found.
- * -3: cannot fstat FILEMAP.
- * -4: cannot read FILEMAP.
+ * global_contents filemap contents (for free)
+ * global_map filemap index.
+ * global_maplines lines of filemap index.
+ *
+ * @return 0: succesful
+ * -1: out of memory.
+ * -2: FILEMAP not found.
+ * -3: cannot fstat FILEMAP.
+ * -4: cannot read FILEMAP.
* -5: format error.
*/
int
@@ -248,19 +246,21 @@
* convert file path name into the URL in the hypertext.
*
* @param[in] path path name in the filesystem.
- * @param[in] line 0: ignored, !=0: line number in @a path.
+ * @param[in] line 0: ignored, !=0: line number in path.
* @param[out] url result url
- * @param[in] size size of @a url
+ * @param[in] size size of url
* @par Globals used (input):
- * #global_contents filemap contents (for free)
- * #global_map filemap index.
- * #global_maplines lines of filemap index.
+ * global_contents filemap contents (for free)
+ * global_map filemap index.
+ * global_maplines lines of filemap index.
*
- * @return 0: succesful
- * 1: path not found
+ * @return 0: succesful
+ * 1: path not found
* -1: filemap not loaded yet
*
- * URL: @CODE{S/\.html\#\}
+ * @code
+ * URL: S/.html#
+ * @endcode
*/
int
htags_path2url(const char *path, int line, char *url, int size)
@@ -285,7 +285,7 @@
/**
* @par Usage:
- * @NAME{htags_path2url} @ARG{filemap} @ARG{path} address@hidden
+ * htags_path2url filemap path [line]
*
* @par Examples:
* @code
diff -ur global-6.5-old/libdb/bt_close.c global-7.7-new/libdb/bt_close.c
--- global-6.5-old/libdb/bt_close.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_close.c 2015-06-17 17:06:46.000000000 +0100
@@ -62,7 +62,7 @@
* @param dbp pointer to access method
* @param abandon 1: don't sync, 0: sync
*
- * @return #RET_ERROR, #RET_SUCCESS
+ * @return RET_ERROR, RET_SUCCESS
*/
int
__bt_close(dbp, abandon)
@@ -122,7 +122,7 @@
* @param dbp pointer to access method
* @param flags
*
- * @return #RET_SUCCESS, #RET_ERROR.
+ * @return RET_SUCCESS, RET_ERROR.
*/
int
__bt_sync(dbp, flags)
@@ -163,7 +163,7 @@
*
* @param t tree
*
- * @return #RET_ERROR, #RET_SUCCESS
+ * @return RET_ERROR, RET_SUCCESS
*/
static int
bt_meta(t)
diff -ur global-6.5-old/libdb/bt_debug.c global-7.7-new/libdb/bt_debug.c
--- global-6.5-old/libdb/bt_debug.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_debug.c 2015-06-17 17:05:26.000000000 +0100
@@ -53,7 +53,7 @@
/**
* BT_DUMP -- Dump the tree
*
- * @param dbp pointer to the #DB
+ * @param dbp pointer to the DB
*/
void
__bt_dump(dbp)
@@ -96,7 +96,7 @@
/**
* BT_DMPAGE -- Dump the meta page
*
- * @param h pointer to the #PAGE
+ * @param h pointer to the PAGE
*/
void
__bt_dmpage(h)
@@ -150,7 +150,7 @@
/**
* BT_DPAGE -- Dump the page
*
- * @param h pointer to the #PAGE
+ * @param h pointer to the PAGE
*/
void
__bt_dpage(h)
@@ -243,7 +243,7 @@
/**
* BT_STAT -- Gather/print the tree statistics
*
- * @param dbp pointer to the #DB
+ * @param dbp pointer to the DB
*/
void
__bt_stat(dbp)
diff -ur global-6.5-old/libdb/bt_delete.c global-7.7-new/libdb/bt_delete.c
--- global-6.5-old/libdb/bt_delete.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_delete.c 2015-06-17 16:58:47.000000000 +0100
@@ -58,9 +58,9 @@
/**
* __bt_delete
- * Delete the item(s) referenced by a @a key.
+ * Delete the item(s) referenced by a key.
*
- * @return #RET_SPECIAL if the key is not found.
+ * @return RET_SPECIAL if the key is not found.
*/
int
__bt_delete(dbp, key, flags)
@@ -136,7 +136,7 @@
* Acquire a stack so we can delete a cursor entry.
*
* @param t tree
- * @param hp pointer to current, pinned #PAGE pointer
+ * @param hp pointer to current, pinned PAGE pointer
* @param c pointer to the cursor
*
* @return 0 on success, 1 on failure
@@ -279,12 +279,12 @@
/**
* __bt_bdelete --
- * Delete all key/data pairs matching the specified @a key.
+ * Delete all key/data pairs matching the specified key.
*
* @param t tree
* @param key key to delete
*
- * @return #RET_ERROR, #RET_SUCCESS and #RET_SPECIAL if the key not found.
+ * @return RET_ERROR, RET_SUCCESS and RET_SPECIAL if the key not found.
*/
static int
__bt_bdelete(t, key)
@@ -366,10 +366,10 @@
* @param t tree
* @param h leaf page
*
- * @return #RET_SUCCESS, #RET_ERROR.
+ * @return RET_SUCCESS, RET_ERROR.
*
* @par Side-effects:
- * #mpool_put's the page
+ * mpool_put's the page
*/
static int
__bt_pdelete(t, h)
@@ -463,7 +463,7 @@
* @param h page
* @param index index on page to delete
*
- * @return #RET_SUCCESS, #RET_ERROR.
+ * @return RET_SUCCESS, RET_ERROR.
*/
int
__bt_dleaf(t, key, h, index)
@@ -522,11 +522,11 @@
* Delete the cursor.
*
* @param t tree
- * @param key referenced key (or @CODE{NULL})
+ * @param key referenced key (or NULL)
* @param h page
* @param index index on page to delete
*
- * @return #RET_SUCCESS, #RET_ERROR.
+ * @return RET_SUCCESS, RET_ERROR.
*/
static int
__bt_curdel(t, key, h, index)
diff -ur global-6.5-old/libdb/bt_get.c global-7.7-new/libdb/bt_get.c
--- global-6.5-old/libdb/bt_get.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_get.c 2015-06-17 17:04:38.000000000 +0100
@@ -54,7 +54,7 @@
* @param data data to return
* @param flags currently unused
*
- * @return #RET_ERROR, #RET_SUCCESS and #RET_SPECIAL if the key not found.
+ * @return RET_ERROR, RET_SUCCESS and RET_SPECIAL if the key not found.
*/
int
__bt_get(dbp, key, data, flags)
diff -ur global-6.5-old/libdb/bt_open.c global-7.7-new/libdb/bt_open.c
--- global-6.5-old/libdb/bt_open.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_open.c 2015-06-17 16:57:01.000000000 +0100
@@ -87,16 +87,16 @@
/**
* __BT_OPEN -- Open a btree.
*
- * Creates and fills a #DB struct, and calls the routine that actually
+ * Creates and fills a DB struct, and calls the routine that actually
* opens the btree.
*
- * @param fname filename (@CODE{NULL} for in-memory trees)
+ * @param fname filename (NULL for in-memory trees)
* @param flags open flag bits
* @param mode open permission bits
- * @param openinfo #BTREEINFO pointer
+ * @param openinfo BTREEINFO pointer
* @param dflags
*
- * @return @CODE{NULL} on failure, pointer to #DB on success.
+ * @return NULL on failure, pointer to DB on success.
*
*/
DB *
@@ -364,7 +364,7 @@
*
* @param t tree
*
- * @return #RET_ERROR, #RET_SUCCESS
+ * @return RET_ERROR, RET_SUCCESS
*/
static int
nroot(t)
diff -ur global-6.5-old/libdb/bt_overflow.c global-7.7-new/libdb/bt_overflow.c
--- global-6.5-old/libdb/bt_overflow.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_overflow.c 2015-06-17 16:55:44.000000000 +0100
@@ -57,14 +57,14 @@
* Big key and data entries are stored on linked lists of pages. The initial
* reference is byte string stored with the key or data and is the page number
* and size. The actual record is stored in a chain of pages linked by the
- * nextpg field of the #PAGE header.
+ * nextpg field of the PAGE header.
*
* The first page of the chain has a special property. If the record is used
- * by an internal page, it cannot be deleted and the #P_PRESERVE bit will be set
+ * by an internal page, it cannot be deleted and the P_PRESERVE bit will be set
* in the header.
*
- * @par XXX
- * A single #DBT is written to each chain, so a lot of space on the last page
+ * XXX
+ * A single DBT is written to each chain, so a lot of space on the last page
* is wasted. This is a fairly major bug for some data sets.
*/
@@ -72,12 +72,12 @@
* __OVFL_GET -- Get an overflow key/data item.
*
* @param t tree
- * @param p pointer to {#pgno_t, @CODE{u_int32_t}}
+ * @param p pointer to {pgno_t, u_int32_t}
* @param ssz
* @param buf storage address
* @param bufsz storage size
*
- * @return #RET_ERROR, #RET_SUCCESS
+ * @return RET_ERROR, RET_SUCCESS
*/
int
__ovfl_get(t, p, ssz, buf, bufsz)
@@ -131,10 +131,10 @@
* __OVFL_PUT -- Store an overflow key/data item.
*
* @param t tree
- * @param dbt #DBT to store
+ * @param dbt DBT to store
* @param pg storage page number
*
- * @return #RET_ERROR, #RET_SUCCESS
+ * @return RET_ERROR, RET_SUCCESS
*/
int
__ovfl_put(t, dbt, pg)
@@ -184,9 +184,9 @@
* __OVFL_DELETE -- Delete an overflow chain.
*
* @param t tree
- * @param p pointer to {#pgno_t, @CODE{u_int32_t}}
+ * @param p pointer to {pgno_t, u_int32_t}
*
- * @return #RET_ERROR, #RET_SUCCESS
+ * @return RET_ERROR, RET_SUCCESS
*/
int
__ovfl_delete(t, p)
diff -ur global-6.5-old/libdb/bt_page.c global-7.7-new/libdb/bt_page.c
--- global-6.5-old/libdb/bt_page.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_page.c 2015-06-17 16:54:28.000000000 +0100
@@ -48,10 +48,10 @@
* @param t tree
* @param h page to free
*
- * @return #RET_ERROR, #RET_SUCCESS
+ * @return RET_ERROR, RET_SUCCESS
*
* @par Side-effect:
- * #mpool_put's the page.
+ * mpool_put's the page.
*/
int
__bt_free(t, h)
@@ -75,7 +75,7 @@
* @param t tree
* @param npg storage for page number.
*
- * @return Pointer to a page, @CODE{NULL} on error.
+ * @return Pointer to a page, NULL on error.
*/
PAGE *
__bt_new(t, npg)
diff -ur global-6.5-old/libdb/bt_put.c global-7.7-new/libdb/bt_put.c
--- global-6.5-old/libdb/bt_put.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_put.c 2015-06-17 16:53:49.000000000 +0100
@@ -61,11 +61,11 @@
* @param dbp pointer to access method
* @param key key
* @param data data
- * @param flags #R_NOOVERWRITE
+ * @param flags R_NOOVERWRITE
*
* @return
- * #RET_ERROR, #RET_SUCCESS and #RET_SPECIAL if the key is already in the
- * tree and #R_NOOVERWRITE specified.
+ * RET_ERROR, RET_SUCCESS and RET_SPECIAL if the key is already in the
+ * tree and R_NOOVERWRITE specified.
*/
int
__bt_put(dbp, key, data, flags)
@@ -262,7 +262,7 @@
* @param data
* @param exactp
*
- * @return #EPG for new record or @CODE{NULL} if not found.
+ * @return EPG for new record or NULL if not found.
*/
static EPG *
bt_fast(t, key, data, exactp)
diff -ur global-6.5-old/libdb/btree.h global-7.7-new/libdb/btree.h
--- global-6.5-old/libdb/btree.h 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/btree.h 2015-06-17 16:47:39.000000000 +0100
@@ -32,12 +32,10 @@
* @(#)btree.h 8.11 (Berkeley) 8/17/94
*/
-/** @name Macros to set/clear/test flags. */
-/** @{ */
+/* Macros to set/clear/test flags. */
#define F_SET(p, f) (p)->flags |= (f)
#define F_CLR(p, f) (p)->flags &= ~(f)
#define F_ISSET(p, f) ((p)->flags & (f))
-/** @} */
#include "mpool.h"
@@ -64,10 +62,10 @@
#define P_ROOT 1
/**
- * There are five page layouts in the btree: btree internal pages (#BINTERNAL),
- * btree leaf pages (#BLEAF), recno internal pages (#RINTERNAL), recno leaf pages
- * (#RLEAF) and overflow pages. All five page types have a page header (#PAGE).
- * @STRONG{This implementation requires that values within structures NOT be padded}.
+ * There are five page layouts in the btree: btree internal pages (BINTERNAL),
+ * btree leaf pages (BLEAF), recno internal pages (RINTERNAL), recno leaf pages
+ * (RLEAF) and overflow pages. All five page types have a page header (PAGE).
+ * This implementation requires that values within structures NOT be padded.
* (ANSI C permits random padding.) If your compiler pads randomly you'll have
* to do some work to get this package to run.
*/
@@ -94,7 +92,7 @@
indx_t lower; /**< lower bound of free space on page */
indx_t upper; /**< upper bound of free space on page */
- indx_t linp[1]; /**< #indx_t-aligned VAR. LENGTH DATA */
+ indx_t linp[1]; /**< indx_t-aligned VAR. LENGTH DATA */
} PAGE;
/** First and next index. */
@@ -106,16 +104,16 @@
/**
* For pages other than overflow pages, there is an array of offsets into the
* rest of the page immediately following the page header. Each offset is to
- * an item which is unique to the type of page. The @NAME{h_lower} offset is just
- * past the last filled-in index. The @NAME{h_upper} offset is the first item on the
+ * an item which is unique to the type of page. The h_lower offset is just
+ * past the last filled-in index. The h_upper offset is the first item on the
* page. Offsets are from the beginning of the page.
*
* If an item is too big to store on a single page, a flag is set and the item
- * is a address@hidden, @NAME{size}} pair such that the page is the first page of an overflow
+ * is a {page, size} pair such that the page is the first page of an overflow
* chain with size bytes of item. Overflow pages are simply bytes without any
* external structure.
*
- * The page number and size fields in the items are #pgno_t-aligned so they can
+ * The page number and size fields in the items are pgno_t-aligned so they can
* be manipulated without copying. (This presumes that 32 bit items can be
* manipulated on this system.)
*/
@@ -123,11 +121,11 @@
#define NOVFLSIZE (sizeof(pgno_t) + sizeof(u_int32_t))
/**
- * For the btree internal pages, the item is a key. @VAR{BINTERNAL}s are address@hidden, @NAME{pgno}}
+ * For the btree internal pages, the item is a key. BINTERNALs are {key, pgno}
* pairs, such that the key compares less than or equal to all of the records
* on that page. For a tree without duplicate keys, an internal page with two
- * consecutive keys, @EMPH{a} and @EMPH{b}, will have all records greater than or equal to @EMPH{a}
- * and less than @EMPH{b} stored on the page associated with @EMPH{a}. Duplicate keys are
+ * consecutive keys, a and b, will have all records greater than or equal to a
+ * and less than b stored on the page associated with a. Duplicate keys are
* somewhat special and can cause duplicate internal and leaf page records and
* some minor modifications of the above rule.
*/
@@ -143,7 +141,7 @@
char bytes[1]; /**< data */
} BINTERNAL;
-/** Get the page's #BINTERNAL structure at index indx. */
+/** Get the page's BINTERNAL structure at index indx. */
#define GETBINTERNAL(pg, indx) \
((BINTERNAL *)((char *)(pg) + (pg)->linp[indx]))
@@ -151,7 +149,7 @@
#define NBINTERNAL(len) \
LALIGN(sizeof(u_int32_t) + sizeof(pgno_t) + sizeof(u_char) + (len))
-/** Copy a #BINTERNAL entry to the page. */
+/** Copy a BINTERNAL entry to the page. */
#define WR_BINTERNAL(p, size, pgno, flags) { \
*(u_int32_t *)p = size; \
p += sizeof(u_int32_t); \
@@ -170,7 +168,7 @@
pgno_t pgno; /**< page number stored below */
} RINTERNAL;
-/** Get the page's #RINTERNAL structure at index indx. */
+/** Get the page's RINTERNAL structure at index indx. */
#define GETRINTERNAL(pg, indx) \
((RINTERNAL *)((char *)(pg) + (pg)->linp[indx]))
@@ -178,7 +176,7 @@
#define NRINTERNAL \
LALIGN(sizeof(recno_t) + sizeof(pgno_t))
-/** Copy a #RINTERNAL entry to the page. */
+/** Copy a RINTERNAL entry to the page. */
#define WR_RINTERNAL(p, nrecs, pgno) { \
*(recno_t *)p = nrecs; \
p += sizeof(recno_t); \
@@ -189,11 +187,11 @@
typedef struct _bleaf {
u_int32_t ksize; /**< size of key */
u_int32_t dsize; /**< size of data */
- u_char flags; /**< #P_BIGDATA, #P_BIGKEY */
+ u_char flags; /**< P_BIGDATA, P_BIGKEY */
char bytes[1]; /**< data */
} BLEAF;
-/** Get the page's #BLEAF structure at index indx. */
+/** Get the page's BLEAF structure at index indx. */
#define GETBLEAF(pg, indx) \
((BLEAF *)((char *)(pg) + (pg)->linp[indx]))
@@ -205,7 +203,7 @@
LALIGN(sizeof(u_int32_t) + sizeof(u_int32_t) + sizeof(u_char) + \
(ksize) + (dsize))
-/** Copy a #BLEAF entry to the page. */
+/** Copy a BLEAF entry to the page. */
#define WR_BLEAF(p, key, data, flags) { \
*(u_int32_t *)p = key->size; \
p += sizeof(u_int32_t); \
@@ -221,11 +219,11 @@
/** For the recno leaf pages, the item is a data entry. */
typedef struct _rleaf {
u_int32_t dsize; /**< size of data */
- u_char flags; /**< #P_BIGDATA */
+ u_char flags; /**< P_BIGDATA */
char bytes[1];
} RLEAF;
-/** Get the page's #RLEAF structure at index indx. */
+/** Get the page's RLEAF structure at index indx. */
#define GETRLEAF(pg, indx) \
((RLEAF *)((char *)(pg) + (pg)->linp[indx]))
@@ -236,7 +234,7 @@
#define NRLEAFDBT(dsize) \
LALIGN(sizeof(u_int32_t) + sizeof(u_char) + (dsize))
-/** Copy a #RLEAF entry to the page. */
+/** Copy a RLEAF entry to the page. */
#define WR_RLEAF(p, data, flags) { \
*(u_int32_t *)p = data->size; \
p += sizeof(u_int32_t); \
@@ -268,18 +266,18 @@
/**
* About cursors. The cursor (and the page that contained the key/data pair
* that it referenced) can be deleted, which makes things a bit tricky. If
- * there are no duplicates of the cursor key in the tree (i.e. #B_NODUPS is set
+ * there are no duplicates of the cursor key in the tree (i.e. B_NODUPS is set
* or there simply aren't any duplicates of the key) we copy the key that it
* referenced when it's deleted, and reacquire a new cursor key if the cursor
* is used again. If there are duplicates keys, we move to the next/previous
- * key, and set a flag so that we know what happened. @b NOTE: if duplicate (to
+ * key, and set a flag so that we know what happened. NOTE: if duplicate (to
* the cursor) keys are added to the tree during this process, it is undefined
* if they will be returned or not in a cursor scan.
*
* The flags determine the possible states of the cursor:
*
* @par CURS_INIT
- * The cursor references @STRONG{*something*}.
+ * The cursor references *something*.
* @par CURS_ACQUIRE
* The cursor was deleted, and a key has been saved so that
* we can reacquire the right position in the tree.
@@ -289,11 +287,11 @@
* deleted key/data pair.
* @par XXX
* This structure is broken out so that we can eventually offer multiple
- * cursors as part of the #DB interface.
+ * cursors as part of the DB interface.
*/
typedef struct _cursor {
EPGNO pg; /**< B: Saved tree reference. */
- DBT key; /**< B: Saved key, or @CODE{key.data == NULL}. */
+ DBT key; /**< B: Saved key, or key.data == NULL. */
recno_t rcursor; /**< R: recno cursor (1-based) */
/** B: Cursor needs to be reacquired. */
@@ -308,7 +306,7 @@
} CURSOR;
/**
- * The metadata of the tree. The @link BTMETA::nrecs nrecs @endlink field is used only by the RECNO code.
+ * The metadata of the tree. The nrecs field is used only by the RECNO code.
* This is because the btree doesn't really need it and it requires that every
* put or delete call modify the metadata.
*/
@@ -320,14 +318,14 @@
u_int32_t nrecs; /**< R: number of records */
#define SAVEMETA (B_NODUPS | R_RECNO)
- u_int32_t flags; /**< bt_flags \& #SAVEMETA */
+ u_int32_t flags; /**< bt_flags & SAVEMETA */
} BTMETA;
/** The in-memory btree/recno data structure. */
typedef struct _btree {
MPOOL *bt_mp; /**< memory pool cookie */
- DB *bt_dbp; /**< pointer to enclosing #DB */
+ DB *bt_dbp; /**< pointer to enclosing DB */
EPG bt_cur; /**< current (pinned) page */
PAGE *bt_pinned; /**< page pinned across calls */
@@ -364,7 +362,7 @@
/** R: recno input function */
int (*bt_irec)(struct _btree *, recno_t);
- FILE *bt_rfp; /**< R: record @VAR{FILE} pointer */
+ FILE *bt_rfp; /**< R: record FILE pointer */
int bt_rfd; /**< R: record file descriptor */
caddr_t bt_cmap; /**< R: current point in mapped space */
@@ -392,11 +390,11 @@
#define B_RDONLY 0x00010
/** no duplicate keys permitted.
- @note #B_NODUPS is stored on disk, and may not be changed. */
+ @note B_NODUPS is stored on disk, and may not be changed. */
#define B_NODUPS 0x00020
/** record oriented tree.
- @note #R_RECNO is stored on disk, and may not be changed. */
+ @note R_RECNO is stored on disk, and may not be changed. */
#define R_RECNO 0x00080
/** opened a file pointer */
@@ -414,11 +412,11 @@
/** read-only file */
#define R_RDONLY 0x02000
- /** #DB_LOCK specified. */
+ /** DB_LOCK specified. */
#define B_DB_LOCK 0x04000
- /** #DB_SHMEM specified. */
+ /** DB_SHMEM specified. */
#define B_DB_SHMEM 0x08000
- /** #DB_TXN specified. */
+ /** DB_TXN specified. */
#define B_DB_TXN 0x10000
u_int32_t flags;
} BTREE;
diff -ur global-6.5-old/libdb/bt_search.c global-7.7-new/libdb/bt_search.c
--- global-6.5-old/libdb/bt_search.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_search.c 2015-06-17 16:52:56.000000000 +0100
@@ -56,9 +56,9 @@
* @param[out] exactp pointer to exact match flag
*
* @return
- * The #EPG for matching record, if any, or the #EPG for the location
+ * The EPG for matching record, if any, or the EPG for the location
* of the key, if it were inserted into the tree, is entered into
- * the BTREE::bt_cur field of the tree. A pointer to the field is returned.
+ * the bt_cur field of the tree. A pointer to the field is returned.
*/
EPG *
__bt_search(t, key, exactp)
@@ -134,7 +134,7 @@
/**
* __bt_snext --
- * Check for an exact match after the @a key.
+ * Check for an exact match after the key.
*
* @param[in] t tree
* @param[in] h current page
@@ -142,7 +142,7 @@
* @param[out] exactp pointer to exact match flag
*
* @return
- * @VAR{TRUE} (1) if an exact match found, else @VAR{FALSE} (0).
+ * TRUE (1) if an exact match found, else FALSE (0).
*/
static int
__bt_snext(t, h, key, exactp)
@@ -172,7 +172,7 @@
/**
* __bt_sprev --
- * Check for an exact match before the @a key.
+ * Check for an exact match before the key.
*
* @param[in] t tree
* @param[in] h current page
@@ -180,7 +180,7 @@
* @param[out] exactp pointer to exact match flag
*
* @return
- * @VAR{TRUE} (1) if an exact match found, else @VAR{FALSE} (0).
+ * TRUE (1) if an exact match found, else FALSE (0).
*/
static int
__bt_sprev(t, h, key, exactp)
diff -ur global-6.5-old/libdb/bt_seq.c global-7.7-new/libdb/bt_seq.c
--- global-6.5-old/libdb/bt_seq.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_seq.c 2015-06-17 17:04:08.000000000 +0100
@@ -69,10 +69,10 @@
* @param dbp pointer to access method
* @param key key for positioning and return value
* @param data data return value
- * @param flags #R_CURSOR, #R_FIRST, #R_LAST, #R_NEXT, #R_PREV.
+ * @param flags R_CURSOR, R_FIRST, R_LAST, R_NEXT, R_PREV.
*
* @return
- * #RET_ERROR, #RET_SUCCESS or #RET_SPECIAL if there's no next key.
+ * RET_ERROR, RET_SUCCESS or RET_SPECIAL if there's no next key.
*/
int
__bt_seq(dbp, key, data, flags)
@@ -140,13 +140,13 @@
* @param t tree
* @param ep storage for returned key
* @param key key for initial scan position
- * @param flags #R_CURSOR, #R_FIRST, #R_LAST, #R_NEXT, #R_PREV
+ * @param flags R_CURSOR, R_FIRST, R_LAST, R_NEXT, R_PREV
*
* @par Side effects:
* Pins the page the cursor references.
*
* @return
- * #RET_ERROR, #RET_SUCCESS or #RET_SPECIAL if there's no next key.
+ * RET_ERROR, RET_SUCCESS or RET_SPECIAL if there's no next key.
*/
static int
__bt_seqset(t, ep, key, flags)
@@ -228,13 +228,13 @@
*
* @param t tree
* @param ep
- * @param flags #R_NEXT, #R_PREV
+ * @param flags R_NEXT, R_PREV
*
* @par Side effects:
* Pins the page the new key/data record is on.
*
* @return
- * #RET_ERROR, #RET_SUCCESS or #RET_SPECIAL if there's no next key.
+ * RET_ERROR, RET_SUCCESS or RET_SPECIAL if there's no next key.
*/
static int
__bt_seqadv(t, ep, flags)
@@ -330,12 +330,12 @@
*
* @param t the tree
* @param key the key
- * @param erval return #EPG
+ * @param erval return EPG
* @param exactp pointer to exact match flag
*
* @return
- * The first entry in the tree greater than or equal to @a key,
- * or #RET_SPECIAL if no such key exists.
+ * The first entry in the tree greater than or equal to key,
+ * or RET_SPECIAL if no such key exists.
*/
static int
__bt_first(t, key, erval, exactp)
diff -ur global-6.5-old/libdb/bt_split.c global-7.7-new/libdb/bt_split.c
--- global-6.5-old/libdb/bt_split.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_split.c 2015-06-17 16:51:46.000000000 +0100
@@ -71,12 +71,12 @@
* @param sp page to split
* @param key key to insert
* @param data data to insert
- * @param flags #P_BIGKEY/#P_BIGDATA flags
+ * @param flags P_BIGKEY/P_BIGDATA flags
* @param ilen insert length
* @param argskip index to leave open
*
* @return
- * #RET_ERROR, #RET_SUCCESS
+ * RET_ERROR, RET_SUCCESS
*/
int
__bt_split(t, sp, key, data, flags, ilen, argskip)
@@ -337,7 +337,7 @@
* @param ilen insert length
*
* @return
- * Pointer to page in which to insert or @CODE{NULL} on error.
+ * Pointer to page in which to insert or NULL on error.
*/
static PAGE *
bt_page(t, h, lp, rp, skip, ilen)
@@ -441,7 +441,7 @@
* @param ilen insert length
*
* @return
- * Pointer to page in which to insert or @CODE{NULL} on error.
+ * Pointer to page in which to insert or NULL on error.
*/
static PAGE *
bt_root(t, h, lp, rp, skip, ilen)
@@ -487,7 +487,7 @@
* @param r right page
*
* @return
- * #RET_ERROR, #RET_SUCCESS
+ * RET_ERROR, RET_SUCCESS
*/
static int
bt_rroot(t, h, l, r)
@@ -526,7 +526,7 @@
* @param r right page
*
* @return
- * #RET_ERROR, #RET_SUCCESS
+ * RET_ERROR, RET_SUCCESS
*/
static int
bt_broot(t, h, l, r)
@@ -779,7 +779,7 @@
* @param pg page number of first page in the chain.
*
* @return
- * #RET_SUCCESS, #RET_ERROR.
+ * RET_SUCCESS, RET_ERROR.
*/
static int
bt_preserve(t, pg)
@@ -803,10 +803,10 @@
* @return
* The number of recno entries below a page.
*
- * @par XXX
- * These values could be set by the #bt_psplit routine. The problem is that the
+ * XXX
+ * These values could be set by the bt_psplit routine. The problem is that the
* entry has to be popped off of the stack etc. or the values have to be passed
- * all the way back to #bt_split/#bt_rroot and it's not very clean.
+ * all the way back to bt_split/bt_rroot and it's not very clean.
*/
static recno_t
rec_total(h)
diff -ur global-6.5-old/libdb/bt_utils.c global-7.7-new/libdb/bt_utils.c
--- global-6.5-old/libdb/bt_utils.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/bt_utils.c 2015-06-17 16:49:39.000000000 +0100
@@ -56,14 +56,14 @@
*
* @param t tree
* @param e key/data pair to be returned
- * @param key user's key structure (@CODE{NULL} if not to be filled in)
- * @param rkey memory area to hold @a key
- * @param data user's data structure (@CODE{NULL} if not to be filled in)
- * @param rdata memory area to hold @a data
+ * @param key user's key structure (NULL if not to be filled in)
+ * @param rkey memory area to hold key
+ * @param data user's data structure (NULL if not to be filled in)
+ * @param rdata memory area to hold data
* @param copy always copy the key/data item
*
* @return
- * #RET_SUCCESS, #RET_ERROR.
+ * RET_SUCCESS, RET_ERROR.
*/
int
__bt_ret(t, e, key, rkey, data, rdata, copy)
@@ -138,17 +138,17 @@
return (RET_SUCCESS);
}
-/**
+/*
* __BT_CMP -- Compare a key to a given record.
*
* @param t tree
- * @param k1 #DBT pointer of first arg to comparison
- * @param e pointer to #EPG for comparison
+ * @param k1 DBT pointer of first arg to comparison
+ * @param e pointer to EPG for comparison
*
* @return
- * \< 0 if @a k1 is \< record
- * = 0 if @a k1 is = record
- * \> 0 if @a k1 is \> record
+ * < 0 if k1 is < record
+ * = 0 if k1 is = record
+ * > 0 if k1 is > record
*/
int
__bt_cmp(t, k1, e)
@@ -201,16 +201,16 @@
return ((*t->bt_cmp)(k1, &k2));
}
-/**
+/*
* __BT_DEFCMP -- Default comparison routine.
*
- * @param a #DBT \#1
- * @param b #DBT \#2
+ * @param a DBT #1
+ * @param b DBT #2
*
* @return
- * \< 0 if @a a is \< @a b
- * = 0 if @a a is = @a b
- * \> 0 if @a a is \> @a b
+ * < 0 if a is < b
+ * = 0 if a is = b
+ * > 0 if a is > b
*/
int
__bt_defcmp(a, b)
@@ -235,11 +235,11 @@
/**
* __BT_DEFPFX -- Default prefix routine.
*
- * @param a #DBT \#1
- * @param b #DBT \#2
+ * @param a DBT #1
+ * @param b DBT #2
*
* @return
- * Number of bytes needed to distinguish @a b from @a a.
+ * Number of bytes needed to distinguish b from a.
*/
size_t
__bt_defpfx(a, b)
diff -ur global-6.5-old/libdb/compat.h global-7.7-new/libdb/compat.h
--- global-6.5-old/libdb/compat.h 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/compat.h 2015-06-18 19:41:12.000000000 +0100
@@ -52,10 +52,10 @@
#define SIG_UNBLOCK 2
#define SIG_SETMASK 3
-static int __sigtemp; /**< For the use of #sigprocmask */
+static int __sigtemp; /**< For the use of sigprocmask */
/** @remark
- * Repeated test of @CODE{oset != NULL} is to avoid @CODE{"*0"}.
+ * Repeated test of oset != NULL is to avoid "*0".
*/
#define sigprocmask(how, set, oset) \
((__sigtemp = \
@@ -69,13 +69,12 @@
sigsetmask(__sigtemp)), 0)
#endif
-/**
- * @name BYTE_ORDER
- * @details
+/*
+ * BYTE_ORDER
+ *
* If your system doesn't have an include file with the appropriate
* byte order set, make sure you specify the correct one.
*/
-/** @{ */
#ifndef BYTE_ORDER
#define LITTLE_ENDIAN 1234
#define BIG_ENDIAN 4321
@@ -85,9 +84,8 @@
#define BYTE_ORDER LITTLE_ENDIAN
#endif
#endif
-/** @} */
-/** @name Compatibility macros */
+/* Compatibility macros */
/*
* Old definitions were rewritten using 'HAVE_XXX' macros.
*
@@ -106,7 +104,6 @@
* #define memmove(a, b, n) bcopy(b, a, n)
* #endif
*/
-/** @{ */
#if !defined (HAVE_INDEX) && defined (HAVE_STRCHR)
#define index(a, b) strchr(a, b)
#endif
@@ -135,79 +132,71 @@
#if !defined (HAVE_MEMMOVE) && defined (HAVE_BCOPY)
#define memmove(a, b, n) bcopy(b, a, n)
#endif
-/** @} */
-/**
+/*
* @def O_ACCMODE
- * @details
- * 32-bit machine. The #DB routines are theoretically independent of
- * the size of @NAME{u_shorts} and @NAME{u_longs}, but I don't know that anyone has
- * ever actually tried it. At a minimum, change the following @CODE{\#define}'s
+ *
+ * 32-bit machine. The DB routines are theoretically independent of
+ * the size of u_shorts and u_longs, but I don't know that anyone has
+ * ever actually tried it. At a minimum, change the following #define's
* if you are trying to compile on a different type of system.
*/
-/** @{ */
-#ifndef O_ACCMODE /** @NAME{POSIX 1003.1} access mode mask. */
+#ifndef O_ACCMODE /** POSIX 1003.1 access mode mask. */
#define O_ACCMODE (O_RDONLY|O_WRONLY|O_RDWR)
#endif
-/** @} */
-#ifndef _POSIX2_RE_DUP_MAX /** @NAME{POSIX 1003.2} RE limit. */
+#ifndef _POSIX2_RE_DUP_MAX /** POSIX 1003.2 RE limit. */
#define _POSIX2_RE_DUP_MAX 255
#endif
/**
* @details
- * If you can't provide lock values in the @XREF{open,2} call. Note, this
+ * If you can't provide lock values in the open(2) call. Note, this
* allows races to happen.
*/
-/** @{ */
-#ifndef O_EXLOCK /** @NAME{4.4BSD} extension. */
+#ifndef O_EXLOCK /** 4.4BSD extension. */
#define O_EXLOCK 0
#endif
-/** @} */
-#ifndef O_SHLOCK /** @NAME{4.4BSD} extension. */
+#ifndef O_SHLOCK /** 4.4BSD extension. */
#define O_SHLOCK 0
#endif
-#ifndef O_BINARY /** @NAME{UNIX} systems don't often have or need this */
+#ifndef O_BINARY /** UNIX systems don't often have or need this */
#define O_BINARY 0
#endif
-#ifndef O_NONBLOCK /** @NAME{Win32} systems doesn't have or need this */
+#ifndef O_NONBLOCK /** Win32 systems doesn't have or need this */
#define O_NONBLOCK 0
#endif
-#ifndef EFTYPE /** @NAME{POSIX 1003.1} format errno. */
+#ifndef EFTYPE /** POSIX 1003.1 format errno. */
#define EFTYPE EINVAL
#endif
-/** @name POSIX 1003.1 seek values */
-/** @{ */
+/* POSIX 1003.1 seek values */
#ifndef SEEK_END
#define SEEK_SET 0
#define SEEK_CUR 1
#define SEEK_END 2
#endif
-/** @} */
-#ifndef _POSIX2_RE_DUP_MAX /** @NAME{POSIX 1003.2} values. */
+#ifndef _POSIX2_RE_DUP_MAX /** POSIX 1003.2 values. */
#define _POSIX2_RE_DUP_MAX 255
#endif
-#ifndef NULL /** @NAME{ANSI C} @CODE{\#define}s @VAR{NULL} everywhere. */
+#ifndef NULL /* ANSI C #defines NULL everywhere. */
#define NULL 0
#endif
-#ifndef MAX /** Usually found in @FILE{\}. */
+#ifndef MAX /* Usually found in "". */
#define MAX(_a,_b) ((_a)<(_b)?(_b):(_a))
#endif
-#ifndef MIN /** Usually found in @FILE{\}. */
+#ifndef MIN /* Usually found in "". */
#define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
#endif
-/** @name POSIX 1003.1 file type tests. */
-/** @{ */
+/* POSIX 1003.1 file type tests. */
#ifndef S_ISDIR
/** directory */
#define S_ISDIR(m) ((m & 0170000) == 0040000)
@@ -220,7 +209,6 @@
/** fifo */
#define S_ISFIFO(m) ((m & 0170000) == 0010000)
#endif
-/** @} */
#ifndef HAVE_LSTAT
#define lstat stat
diff -ur global-6.5-old/libdb/db.c global-7.7-new/libdb/db.c
--- global-6.5-old/libdb/db.c 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/db.c 2015-06-17 17:02:04.000000000 +0100
@@ -87,7 +87,7 @@
/**
* __DBPANIC -- Stop.
*
- * @param dbp pointer to the #DB structure.
+ * @param dbp pointer to the DB structure.
*/
void
__dbpanic(dbp)
diff -ur global-6.5-old/libdb/db.h global-7.7-new/libdb/db.h
--- global-6.5-old/libdb/db.h 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/db.h 2015-06-17 16:35:42.000000000 +0100
@@ -45,28 +45,23 @@
#include "compat.h"
-/** @name Return values. */
-/** @{ */
+/* Return values. */
#define RET_ERROR -1
#define RET_SUCCESS 0
#define RET_SPECIAL 1
-/** @} */
-/** @name */
-/** @{ */
- /** >= \# of pages in a file */
+ /** >= # of pages in a file */
#define MAX_PAGE_NUMBER 0xffffffff
/** pgno_t */
#define pgno_t u_int32_t
- /** >= \# of bytes in a page */
+ /** >= # of bytes in a page */
#define MAX_PAGE_OFFSET 65535
/** indx_t */
#define indx_t u_int16_t
- /** >= \# of records in a tree */
+ /** >= # of records in a tree */
#define MAX_REC_NUMBER 0xffffffff
/** recno_t */
#define recno_t u_int32_t
-/** @} */
/** Key/data structure -- a Data-Base Thang. */
typedef struct {
@@ -74,8 +69,7 @@
size_t size; /**< data length */
} DBT;
-/** @name Routine flags. */
-/** @{ */
+/* Routine flags. */
/** del, put, seq */
#define R_CURSOR 1
/** UNUSED */
@@ -86,34 +80,33 @@
#define R_IAFTER 4
/** put (RECNO) */
#define R_IBEFORE 5
- /** seq (#BTREE, RECNO) */
+ /** seq (BTREE, RECNO) */
#define R_LAST 6
/** seq */
#define R_NEXT 7
/** put */
#define R_NOOVERWRITE 8
- /** seq (#BTREE, RECNO) */
+ /** seq (BTREE, RECNO) */
#define R_PREV 9
/** put (RECNO) */
#define R_SETCURSOR 10
/** sync (RECNO) */
#define R_RECNOSYNC 11
-/** @} */
typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;
/**
* !!!
- * The following flags are included in the @XREF{dbopen,3} call as part of the
- * @XREF{open,2} flags. In order to avoid conflicts with the open flags, start
+ * The following flags are included in the dbopen(3) call as part of the
+ * open(2) flags. In order to avoid conflicts with the open flags, start
* at the top of the 16 or 32-bit number space and work our way down. If
* the open flags were significantly expanded in the future, it could be
- * a problem. Wish I'd left another flags word in the @NAME{dbopen} call.
+ * a problem. Wish I'd left another flags word in the dbopen call.
*
* !!!
- * @EMPH{None of this stuff is implemented yet}. The only reason that it's here
+ * None of this stuff is implemented yet. The only reason that it's here
* is so that the access methods can skip copying the key/data pair when
- * the #DB_LOCK flag isn't set.
+ * the DB_LOCK flag isn't set.
*/
#if UINT_MAX > 65535
/** Do locking. */
@@ -146,13 +139,10 @@
int (*fd) (const struct __db *);
} DB;
-/** @name */
-/** @{ */
#define BTREEMAGIC 0x053162
#define BTREEVERSION 3
/** duplicate keys */
#define R_DUP 0x01
-/** @} */
/** Structure used to pass parameters to the btree routines. */
typedef struct {
@@ -200,13 +190,12 @@
char *bfname; /**< btree file name */
} RECNOINFO;
-/**
- * @name Little endian <==> big endian 32-bit swap macros.
- * #M_32_SWAP swap a memory location
- * #P_32_SWAP swap a referenced memory location
- * #P_32_COPY swap from one location to another
+/*
+ * Little endian <==> big endian 32-bit swap macros.
+ * M_32_SWAP swap a memory location
+ * P_32_SWAP swap a referenced memory location
+ * P_32_COPY swap from one location to another
*/
-/** @{ */
#define M_32_SWAP(a) { \
u_int32_t _tmp = a; \
((char *)&a)[0] = ((char *)&_tmp)[3]; \
@@ -227,15 +216,13 @@
((char *)&(b))[2] = ((char *)&(a))[1]; \
((char *)&(b))[3] = ((char *)&(a))[0]; \
}
-/** @} */
-/**
- * @name Little endian <==> big endian 16-bit swap macros.
- * #M_16_SWAP swap a memory location
- * #P_16_SWAP swap a referenced memory location
- * #P_16_COPY swap from one location to another
+/*
+ * Little endian <==> big endian 16-bit swap macros.
+ * M_16_SWAP swap a memory location
+ * P_16_SWAP swap a referenced memory location
+ * P_16_COPY swap from one location to another
*/
-/** @{ */
#define M_16_SWAP(a) { \
u_int16_t _tmp = a; \
((char *)&a)[0] = ((char *)&_tmp)[1]; \
@@ -250,7 +237,6 @@
((char *)&(b))[0] = ((char *)&(a))[1]; \
((char *)&(b))[1] = ((char *)&(a))[0]; \
}
-/** @} */
DB *dbopen(const char *, int, int, DBTYPE, const void *);
diff -ur global-6.5-old/libdb/mpool.h global-7.7-new/libdb/mpool.h
--- global-6.5-old/libdb/mpool.h 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/mpool.h 2015-06-17 16:59:41.000000000 +0100
@@ -36,7 +36,7 @@
* by a bucket which is threaded in up to two of three ways. All active pages
* are threaded on a hash chain (hashed by page number) and an lru chain.
* Inactive pages are threaded on a free chain. Each reference to a memory
- * pool is handed an opaque #MPOOL cookie which stores all of this information.
+ * pool is handed an opaque MPOOL cookie which stores all of this information.
*/
#define HASHSIZE 128
#define HASHKEY(pgno) ((pgno - 1) % HASHSIZE)
diff -ur global-6.5-old/libdb/queue.h global-7.7-new/libdb/queue.h
--- global-6.5-old/libdb/queue.h 2015-06-10 02:45:08.000000000 +0100
+++ global-7.7-new/libdb/queue.h 2015-06-17 16:32:37.000000000 +0100
@@ -42,7 +42,7 @@
*
* A singly-linked list is headed by a single forward pointer. The elements
* are singly linked for minimum space and pointer manipulation overhead at
- * the expense of @CODE{O(n)} removal for arbitrary elements. New elements can be
+ * the expense of O(n) removal for arbitrary elements. New elements can be
* added to the list after an existing element or at the head of the list.
* Elements being removed from the head of the list should use the explicit
* macro for this purpose for optimum efficiency. A singly-linked list may
@@ -53,7 +53,7 @@
* A singly-linked tail queue is headed by a pair of pointers, one to the
* head of the list and the other to the tail of the list. The elements are
* singly linked for minimum space and pointer manipulation overhead at the
- * expense of @CODE{O(n)} removal for arbitrary elements. New elements can be added
+ * expense of O(n) removal for arbitrary elements. New elements can be added
* to the list after an existing element, at the head of the list, or at the
* end of the list. Elements being removed from the head of the tail queue
* should use the explicit macro for this purpose for optimum efficiency.
@@ -83,7 +83,7 @@
* A circle queue may be traversed in either direction, but has a more
* complex end of list detection.
*
- * For details on the use of these macros, see the @XREF{queue,3} manual page.
+ * For details on the use of these macros, see the queue(3) manual page.
*
* @code{.txt}
* SLIST LIST STAILQ TAILQ CIRCLEQ
@@ -106,10 +106,9 @@
* @endcode
*/
-/**
+/*
* Singly-linked List definitions.
*/
-/** @{ */
#define SLIST_HEAD(name, type) \
struct name { \
struct type *slh_first; /**< first element */ \
@@ -122,12 +121,10 @@
struct { \
struct type *sle_next; /**< next element */ \
}
-/** @} */
-/**
+/*
* Singly-linked List functions.
*/
-/** @{ */
#define SLIST_EMPTY(head) ((head)->slh_first == NULL)
#define SLIST_FIRST(head) ((head)->slh_first)
@@ -167,12 +164,10 @@
curelm->field.sle_next->field.sle_next; \
} \
} while (0)
-/** @} */
-/**
+/*
* Singly-linked Tail queue definitions.
*/
-/** @{ */
#define STAILQ_HEAD(name, type) \
struct name { \
struct type *stqh_first;/**< first element */ \
@@ -186,12 +181,10 @@
struct { \
struct type *stqe_next; /**< next element */ \
}
-/** @} */
-/**
+/*
* Singly-linked Tail queue functions.
*/
-/** @{ */
#define STAILQ_EMPTY(head) ((head)->stqh_first == NULL)
#define STAILQ_INIT(head) do { \
@@ -254,12 +247,10 @@
(head)->stqh_last = &(curelm)->field.stqe_next; \
} \
} while (0)
-/** @} */
-/**
+/*
* List definitions.
*/
-/** @{ */
#define LIST_HEAD(name, type) \
struct name { \
struct type *lh_first; /**< first element */ \
@@ -273,12 +264,10 @@
struct type *le_next; /**< next element */ \
struct type **le_prev; /**< address of previous next element */ \
}
-/** @} */
-/**
+/*
* List functions.
*/
-/** @{ */
#define LIST_EMPTY(head) ((head)->lh_first == NULL)
#define LIST_FIRST(head) ((head)->lh_first)
@@ -320,12 +309,10 @@
(elm)->field.le_prev; \
*(elm)->field.le_prev = (elm)->field.le_next; \
} while (0)
-/** @} */
-/**
+/*
* Tail queue definitions.
*/
-/** @{ */
#define TAILQ_HEAD(name, type) \
struct name { \
struct type *tqh_first; /**< first element */ \
@@ -340,12 +327,10 @@
struct type *tqe_next; /**< next element */ \
struct type **tqe_prev; /**< address of previous next element */ \
}
-/** @} */
-/**
+/*
* Tail queue functions.
*/
-/** @{ */
#define TAILQ_EMPTY(head) ((head)->tqh_first == NULL)
#define TAILQ_FOREACH(var, head, field) \
@@ -413,12 +398,10 @@
(head)->tqh_last = (elm)->field.tqe_prev; \
*(elm)->field.tqe_prev = (elm)->field.tqe_next; \
} while (0)
-/** @} */
-/**
+/*
* Circular queue definitions.
*/
-/** @{ */
#define CIRCLEQ_HEAD(name, type) \
struct name { \
struct type *cqh_first; /**< first element */ \
@@ -430,12 +413,10 @@
struct type *cqe_next; /**< next element */ \
struct type *cqe_prev; /**< previous element */ \
}
-/** @} */
-/**
+/*
* Circular queue functions.
*/
-/** @{ */
#define CIRCLEQ_EMPTY(head) ((head)->cqh_first == (void *)(head))
#define CIRCLEQ_FIRST(head) ((head)->cqh_first)
@@ -513,13 +494,12 @@
(elm)->field.cqe_prev->field.cqe_next = \
(elm)->field.cqe_next; \
} while (0)
-/** @} */
#ifdef _KERNEL
/*
- * @par XXX
- * @NAME{insque()} and @NAME{remque()} are an old way of handling certain queues.
+ * XXX
+ * insque() and remque() are an old way of handling certain queues.
* They bogusly assumes that all queue heads look alike.
*/
diff -ur global-6.5-old/libparser/parser.c global-7.7-new/libparser/parser.c
--- global-6.5-old/libparser/parser.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libparser/parser.c 2015-06-15 19:04:04.000000000 +0100
@@ -271,7 +271,7 @@
/**
* get language entry.
*
- * @param[in] lang language name (@CODE{NULL} means 'not specified'.)
+ * @param[in] lang language name (NULL means 'not specified'.)
* @return language entry
*/
static const struct lang_entry *
@@ -314,23 +314,23 @@
* 1. Load langmap and pluginspec, and initialize parsers.
*
* @par
- * @CODE{parser_init(langmap, plugin_parser);}
+ * parser_init(langmap, plugin_parser);
*
* 2. Execute parsers
*
* @par
- * @CODE{#parse_file(...);}
+ * parse_file(...);
*
* 3. Unload parsers.
*
* @par
- * @CODE{parser_exit();}
+ * parser_exit();
*/
-/**
+/*
* parser_init: load langmap and shared libraries.
*
- * @param[in] langmap the value of @CODE{langmap=\}
- * @param[in] pluginspec the value of @CODE{gtags_parser=\}
+ * @param[in] langmap the value of langmap=
+ * @param[in] pluginspec the value of gtags_parser=
*/
void
parser_init(const char *langmap, const char *pluginspec)
@@ -371,8 +371,8 @@
* parse_file: select and execute a parser.
*
* @param[in] path path name
- * @param[in] flags #PARSER_WARNING: print warning messages
- * @param[in] put callback routine
+ * @param[in] flags PARSER_WARNING: print warning messages
+ * @param[in] put callback routine,
* each parser use this routine for output
* @param[in] arg argument for callback routine
*/
diff -ur global-6.5-old/libparser/parser.h global-7.7-new/libparser/parser.h
--- global-6.5-old/libparser/parser.h 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libparser/parser.h 2015-06-15 19:06:16.000000000 +0100
@@ -28,16 +28,13 @@
void parser_init(const char *, const char *);
void parser_exit(void);
-/** @name tag type */
-/** @{ */
+/* tag type */
/** definition */
#define PARSER_DEF 1
/** reference or other symbol */
#define PARSER_REF_SYM 2
-/** @} */
-/** @name flags */
-/** @{ */
+/* flags */
/** debug mode */
#define PARSER_DEBUG 1
/** verbose mode */
@@ -50,7 +47,6 @@
#define PARSER_BEGIN_BLOCK 16
/** gtags --explain */
#define PARSER_EXPLAIN 32
-/** @} */
typedef void (*PARSER_CALLBACK)(int, const char *, int, const char *, const char *, void *);
diff -ur global-6.5-old/libutil/abs2rel.c global-7.7-new/libutil/abs2rel.c
--- global-6.5-old/libutil/abs2rel.c 2015-06-19 18:46:12.000000000 +0100
+++ global-7.7-new/libutil/abs2rel.c 2015-06-19 19:17:47.000000000 +0100
@@ -193,17 +193,17 @@
* normalize: normalize path name
*
* @param[in] path path name
- * @param[in] root root of project (@STRONG{must be end with a '/'})
+ * @param[in] root root of project (must be end with a '/')
* @param[in] cwd current directory
* @param[out] result normalized path name
- * @param[in] size size of the @a result
- * @return ==NULL: error
- * !=NULL: @a result
+ * @param[in] size size of the result
+ * @return ==NULL: error,
+ * !=NULL: result
*
- * @note Calls die() if the result path name is too long (#MAXPATHLEN).
+ * @note Calls die() if the result path name is too long (MAXPATHLEN).
*/
char *
-normalize(const char *path, const char *root, const char *cwd, char *result, const int size)
+normalize(const char *path, const char *root, const char *cwd, char *result, int size)
{
char *p, abs[MAXPATHLEN];
@@ -245,8 +245,8 @@
*
* @param[in] path relative path name
* @param[out] result result buffer
- * @param[in] size size of @a result buffer
- * @return != NULL: normalized path name
+ * @param[in] size size of result buffer
+ * @return != NULL: normalized path name,
* == NULL: error (ERANGE)
*
* @par Examples:
@@ -264,7 +264,7 @@
* @endcode
*/
char *
-normalize_pathname(const char *path, char *result, const int size)
+normalize_pathname(const char *path, char *result, int size)
{
const char *savep, *p = path;
char *final, *q = result;
@@ -358,14 +358,14 @@
* abs2rel: convert an absolute path name into relative.
*
* @param[in] path absolute path
- * @param[in] base base directory (@STRONG{must be absolute path})
+ * @param[in] base base directory (must be absolute path)
* @param[out] result result buffer
- * @param[in] size size of @a result buffer
- * @return != NULL: relative path
+ * @param[in] size size of result buffer
+ * @return != NULL: relative path,
* == NULL: error (ERANGE or EINVAL)
*/
char *
-abs2rel(const char *path, const char *base, char *result, const int size)
+abs2rel(const char *path, const char *base, char *result, int size)
{
const char *pp, *bp, *branch;
/*
@@ -489,14 +489,14 @@
* rel2abs: convert an relative path name into absolute.
*
* @param[in] path relative path
- * @param[in] base base directory (@STRONG{must be absolute path})
+ * @param[in] base base directory (must be absolute path)
* @param[out] result result buffer
- * @param[in] size size of @a result buffer
- * @return != NULL: absolute path
+ * @param[in] size size of result buffer
+ * @return != NULL: absolute path,
* == NULL: error (ERANGE or EINVAL)
*/
char *
-rel2abs(const char *path, const char *base, char *result, const int size)
+rel2abs(const char *path, const char *base, char *result, int size)
{
const char *pp, *bp;
/*
diff -ur global-6.5-old/libutil/abs2rel.h global-7.7-new/libutil/abs2rel.h
--- global-6.5-old/libutil/abs2rel.h 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/abs2rel.h 2015-06-18 19:49:26.000000000 +0100
@@ -20,9 +20,9 @@
#ifndef _RELATIVE_H_
#define _RELATIVE_H_
-char *normalize(const char *, const char *, const char *, char *, const int);
-char *normalize_pathname(const char *, char *, const int);
-char *abs2rel(const char *, const char *, char *, const int);
-char *rel2abs(const char *, const char *, char *, const int);
+char *normalize(const char *, const char *, const char *, char *, int);
+char *normalize_pathname(const char *, char *, int);
+char *abs2rel(const char *, const char *, char *, int);
+char *rel2abs(const char *, const char *, char *, int);
#endif /* ! _RELATIVE_H_ */
diff -ur global-6.5-old/libutil/args.c global-7.7-new/libutil/args.c
--- global-6.5-old/libutil/args.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/args.c 2015-06-15 17:04:41.000000000 +0100
@@ -53,10 +53,10 @@
argslist = args;
}
/**
- * args_open_filelist: #args_open like interface for handling output of @XREF{find,1}.
+ * args_open_filelist: args_open like interface for handling output of find(1).
*
- * @param[in] filename file including list of file names.
- * When @FILE{-} is specified, read from standard input.
+ * @param[in] filename file including list of file names.
+ * When "-" is specified, read from standard input.
*/
void
args_open_filelist(const char *filename)
@@ -71,11 +71,11 @@
}
}
/**
- * args_open_both: #args_open like interface for argument and file list.
+ * args_open_both: args_open like interface for argument and file list.
*
* @param[in] args args array
- * @param[in] filename file including list of file names.
- * When @FILE{-} is specified, read from standard input.
+ * @param[in] filename file including list of file names.
+ * When "-" is specified, read from standard input.
*/
void
args_open_both(const char **args, const char *filename)
@@ -91,9 +91,9 @@
}
}
/**
- * args_open_gfind: #args_open like interface for handling output of @NAME{gfind}.
+ * args_open_gfind: args_open like interface for handling output of gfind.
*
- * @param[in] agp #GFIND descriptor
+ * @param[in] agp GFIND descriptor
*/
void
args_open_gfind(GFIND *agp)
@@ -109,7 +109,7 @@
/**
* args_read: read path From args.
*
- * @return path (@VAR{NULL}: end of argument)
+ * @return path (NULL: end of argument)
*/
const char *
args_read(void)
@@ -173,8 +173,8 @@
* @param[in] argc main()'s argc integer
* @param[in] argv main()'s argv string array
*
- * Setup the @FILE{GTAGSCONF} and the @FILE{GTAGSLABEL} environment variables
- * according to the @OPTION{--gtagsconf} and @OPTION{--gtagslabel} options.
+ * Setup the "GTAGSCONF" and the "GTAGSLABEL" environment variables
+ * according to the --gtagsconf and --gtagslabel options.
*/
void
preparse_options(int argc, char *const *argv)
@@ -221,7 +221,7 @@
}
/**
* prepend_options: creates a new argv main() array, by prepending (space separated)
- * options and arguments from the string argument @a options.
+ * options and arguments from the string argument options.
*
* @param[in,out] argc pointer to main()'s argc integer
* @param[in] argv main()'s argv string array
diff -ur global-6.5-old/libutil/checkalloc.c global-7.7-new/libutil/checkalloc.c
--- global-6.5-old/libutil/checkalloc.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/checkalloc.c 2015-06-18 19:56:15.000000000 +0100
@@ -34,7 +34,7 @@
* @details
* check_malloc: memory allocator
*
- * Uses @NAME{malloc()}.
+ * Uses malloc().
*
* @note Does not return if memory is not available, calls die() instead.
*/
@@ -51,7 +51,7 @@
* @details
* check_calloc: memory allocator
*
- * Uses @NAME{calloc()}.
+ * Uses calloc().
*
* @note Does not return if memory is not available, calls die() instead.
*/
@@ -67,7 +67,7 @@
* @details
* check_realloc: memory allocator
*
- * Uses @NAME{realloc()}.
+ * Uses realloc().
*
* @note Does not return if memory is not available, calls die() instead.
*/
diff -ur global-6.5-old/libutil/compress.c global-7.7-new/libutil/compress.c
--- global-6.5-old/libutil/compress.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/compress.c 2015-06-14 15:53:33.000000000 +0100
@@ -36,7 +36,7 @@
* @file
* Compress module
*
- * Function compress() reduces the size of @NAME{GTAGS} by about 10-20% average.
+ * Function compress() reduces the size of GTAGS by about 10-20% average.
*
* @par PROTOCOL:
*
@@ -67,9 +67,8 @@
* @endcode
*
* @par DATA STRUCTURE
- *
* - #ab2name table is used to convert from abbreviation character
- * to the string value.
+ * to the string value.
* - #name2ab table is used to convert from string value to the
* abbreviation character.
*
diff -ur global-6.5-old/libutil/conf.c global-7.7-new/libutil/conf.c
--- global-6.5-old/libutil/conf.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/conf.c 2015-06-15 17:07:35.000000000 +0100
@@ -58,7 +58,7 @@
static char *confline;
static char *config_path;
/**
- * 32 level nested @CODE{tc=} or @CODE{include=} is allowed.
+ * 32 level nested tc= or include= is allowed.
*/
static int allowed_nest_level = 32;
static int opened;
@@ -113,7 +113,7 @@
* readrecord: read recoed indexed by label.
*
* @param[in] label label in config file
- * @return record or @VAR{NULL}
+ * @return record or NULL
*
* @par Jobs:
* - skip comment.
@@ -171,7 +171,7 @@
return NULL;
}
/**
- * includelabel: procedure for @CODE{tc=} (or @CODE{include=})
+ * includelabel: procedure for tc= (or include=)
*
* @param[out] sb string buffer
* @param[in] label record label
@@ -206,7 +206,7 @@
* configpath: get path of configuration file.
*
* @param[in] rootdir Project root directory
- * @return path name of the configuration file or @VAR{NULL}
+ * @return path name of the configuration file or NULL
*/
static char *
configpath(const char *rootdir)
@@ -247,7 +247,7 @@
* @param[in] rootdir Project root directory
*
* @par Globals used (output):
- * #confline: specified entry
+ * confline: specified entry
*/
void
openconf(const char *rootdir)
@@ -325,7 +325,7 @@
* getconfn: get property number
*
* @param[in] name property name
- * @param[out] num value (if not @VAR{NULL})
+ * @param[out] num value (if not NULL)
* @return 1: found, 0: not found
*/
int
@@ -349,7 +349,7 @@
* getconfs: get property string
*
* @param[in] name property name
- * @param[out] sb string buffer (if not @VAR{NULL})
+ * @param[out] sb string buffer (if not NULL)
* @return 1: found, 0: not found
*/
int
@@ -436,7 +436,7 @@
* getconfb: get property bool value
*
* @param[in] name property name
- * @return 1: @VAR{TRUE}, 0: @VAR{FALSE}
+ * @return 1: TRUE, 0: FALSE
*/
int
getconfb(const char *name)
diff -ur global-6.5-old/libutil/conf.h global-7.7-new/libutil/conf.h
--- global-6.5-old/libutil/conf.h 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/conf.h 2015-06-14 15:48:17.000000000 +0100
@@ -24,8 +24,8 @@
#include "strbuf.h"
/**
* @file
- * Access library for @FILE{gtags.conf} (@FILE{.globalrc}).
- * File format is a subset of @NAME{XXXcap} (@NAME{termcap}, @NAME{printcap}) file.
+ * Access library for "gtags.conf" (".globalrc").
+ * File format is a subset of XXXcap (termcap, printcap) file.
*/
#define GTAGSCONF "/etc/gtags.conf"
#define DEBIANCONF "/etc/gtags/gtags.conf"
diff -ur global-6.5-old/libutil/date.c global-7.7-new/libutil/date.c
--- global-6.5-old/libutil/date.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/date.c 2015-06-15 17:08:36.000000000 +0100
@@ -30,14 +30,14 @@
#include "die.h"
#include "strlimcpy.h"
#include "date.h"
-/**
+/*
* now: current date and time
*
* @return date and time
*
- * If function @NAME{strftime()} is available on your system, the format of the date
- * and time returned is @CODE{'\%a \%b \%d \%H:\%M:\%S \%Z \%Y'} using local time, otherwise
- * the @NAME{date} shell command is used. If there's an error with the date command version
+ * If function strftime() is available on your system, the format of the date
+ * and time returned is '%a %b %d %H:%M:%S %Z %Y' using local time, otherwise
+ * the date shell command is used. If there's an error with the date command version
* of this function, the string returned will be 'unknown time'.
*
* @note The returned string will be overwritten on the next call of this function.
diff -ur global-6.5-old/libutil/dbop.c global-7.7-new/libutil/dbop.c
--- global-6.5-old/libutil/dbop.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/dbop.c 2015-06-15 17:11:32.000000000 +0100
@@ -65,13 +65,13 @@
#endif
/**
- * Though the prefix of the key of meta record is currently only a @CODE{' '} (blank),
+ * Though the prefix of the key of meta record is currently only a ' ' (blank),
* this will be enhanced in the future.
*/
#define ismeta(p) (*((char *)(p)) <= ' ')
/**
- * Stuff for #DBOP_SORTED_WRITE
+ * Stuff for DBOP_SORTED_WRITE
*/
#define SORT_SEP '\t'
@@ -213,9 +213,9 @@
* @param[in] mode 0: read only, 1: create, 2: modify
* @param[in] perm file permission
* @param[in] flags
- * #DBOP_DUP: allow duplicate records.
- * #DBOP_SORTED_WRITE: use sorted writing. This requires @NAME{POSIX} sort.
- * @return descripter for @NAME{dbop_xxx()} or @VAR{NULL}
+ * DBOP_DUP: allow duplicate records.
+ * DBOP_SORTED_WRITE: use sorted writing. This requires POSIX sort.
+ * @return descripter for dbop_xxx() or NULL
*
* Sorted wirting is fast because all writing is done by not insertion but addition.
*/
@@ -299,7 +299,7 @@
*
* @param[in] dbop descripter
* @param[in] name name
- * @return pointer to data or @VAR{NULL}
+ * @return pointer to data or NULL
*/
const char *
dbop_get(DBOP *dbop, const char *name)
@@ -510,14 +510,14 @@
* dbop_first: get first record.
*
* @param[in] dbop dbop descripter
- * @param[in] name key value or prefix
- * !=NULL: indexed read by key
+ * @param[in] name key value or prefix,
+ * !=NULL: indexed read by key,
* ==NULL: sequential read
* @param[in] preg compiled regular expression if any.
- * @param[in] flags following dbop_next call take over this.
- * #DBOP_KEY: read key part
- * #DBOP_PREFIX: prefix read; only valid when sequential read
- * @return data or @VAR{NULL}
+ * @param[in] flags following dbop_next call take over this.
+ * DBOP_KEY: read key part,
+ * DBOP_PREFIX: prefix read; only valid when sequential read
+ * @return data or NULL
*/
const char *
dbop_first(DBOP *dbop, const char *name, regex_t *preg, int flags)
@@ -598,7 +598,7 @@
* dbop_next: get next record.
*
* @param[in] dbop dbop descripter
- * @return data or @VAR{NULL}
+ * @return data or NULL
*
* @note dbop_next() always skip meta records.
*/
@@ -683,7 +683,7 @@
/**
* get_flag: get flag value
*
- * @note Will return an empty string (not @VAR{NULL}), if not found/can't get.
+ * @note Will return an empty string (not NULL), if not found/can't get.
*/
const char *
dbop_getflag(DBOP *dbop)
@@ -711,7 +711,7 @@
/**
* dbop_getoption: get option
*
- * @return the option's value or @VAR{NULL}
+ * @return the option's value or NULL
*/
const char *
dbop_getoption(DBOP *dbop, const char *key)
diff -ur global-6.5-old/libutil/dbop.h global-7.7-new/libutil/dbop.h
--- global-6.5-old/libutil/dbop.h 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/dbop.h 2015-06-15 17:14:42.000000000 +0100
@@ -44,38 +44,33 @@
#define VERSIONKEY " __.VERSION"
typedef struct {
- /**
- * @name (1) COMMON PART
+ /*
+ * (1) COMMON PART
*/
- /** @{ */
int mode; /**< 0:read, 1:create, 2:modify */
- int openflags; /**< flags of @NAME{xxxx_open()} */
- int ioflags; /**< flags of @NAME{xxxx_first()} */
+ int openflags; /**< flags of xxxx_open() */
+ int ioflags; /**< flags of xxxx_first() */
char *lastdat; /**< the data of last located record */
int lastsize; /**< the size of the lastdat */
char *lastkey; /**< the key of last located record */
int lastkeysize; /**< the size of the key */
regex_t *preg; /**< compiled regular expression */
int unread; /**< leave record to read again */
- const char *put_errmsg; /**< error message for @NAME{put_xxx()} */
- /** @} */
+ const char *put_errmsg; /**< error message for put_xxx() */
- /**
- * @name (2) DB185 PART
+ /*
+ * (2) DB185 PART
*/
- /** @{ */
DB *db; /**< descripter of DB */
char dbname[MAXPATHLEN]; /**< dbname */
char key[MAXKEYLEN]; /**< key */
int keylen; /**< key length */
char prev[MAXKEYLEN]; /**< previous key value */
int perm; /**< file permission */
- /** @} */
- /**
- * @name (3) sorted write
+ /*
+ * (3) sorted write
*/
- /** @{ */
FILE *sortout; /**< write to sort command */
FILE *sortin; /**< read from sort command */
#if defined(_WIN32) && !defined(__CYGWIN__)
@@ -83,10 +78,9 @@
#else
int pid; /**< sort process id */
#endif
- /** @} */
#ifdef USE_SQLITE3
- /**
- * @name (4) sqlite3 part
+ /*
+ * (4) sqlite3 part
*/
sqlite3 *db3;
STRBUF *sb;
@@ -105,22 +99,19 @@
#endif
} DBOP;
-/**
- * @name openflags
+/*
+ * openflags
*/
-/** @{ */
/** allow duplicate records */
#define DBOP_DUP 1
#ifdef USE_SQLITE3
- /* use sqlite3 database */
+ /** use sqlite3 database */
#define DBOP_SQLITE3 2
#endif
-/** @} */
-/**
- * @name ioflags
+/*
+ * ioflags
*/
-/** @{ */
/** read key part */
#define DBOP_KEY 1
/** prefixed read */
@@ -129,7 +120,6 @@
#define DBOP_RAW 4
/** sorted write */
#define DBOP_SORTED_WRITE 8
-/** @} */
DBOP *dbop_open(const char *, int, int, int);
const char *dbop_get(DBOP *, const char *);
diff -ur global-6.5-old/libutil/encodepath.c global-7.7-new/libutil/encodepath.c
--- global-6.5-old/libutil/encodepath.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/encodepath.c 2015-06-14 15:32:08.000000000 +0100
@@ -79,7 +79,7 @@
* use_encoding:
*/
int
-use_encoding()
+use_encoding(void)
{
return encoding;
}
diff -ur global-6.5-old/libutil/env.c global-7.7-new/libutil/env.c
--- global-6.5-old/libutil/env.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/env.c 2015-06-14 15:31:27.000000000 +0100
@@ -46,7 +46,7 @@
* @param[in] var environment variable
* @param[in] val value
*
- * Machine independent version of @XREF{setenv,3}.
+ * Machine independent version of setenv(3).
*/
void
set_env(const char *var, const char *val)
diff -ur global-6.5-old/libutil/fileop.c global-7.7-new/libutil/fileop.c
--- global-6.5-old/libutil/fileop.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/fileop.c 2015-06-15 17:22:00.000000000 +0100
@@ -107,7 +107,7 @@
* @param[in] compress 0: normal, 1: compress
* @return file descripter
*
- * @note Uses the @NAME{gzip} program to compress, which should already be on your system.
+ * @note Uses the gzip program to compress, which should already be on your system.
*/
FILEOP *
open_output_file(const char *path, int compress)
@@ -161,12 +161,7 @@
fclose(fileop->fp);
free(fileop);
}
-/**
- * copy file
- *
- * @param[in] src source file
- * @param[in] dist distination file
- */
+
/*
void
copyfile(const char *src, const char *dist)
diff -ur global-6.5-old/libutil/find.c global-7.7-new/libutil/find.c
--- global-6.5-old/libutil/find.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/find.c 2015-06-15 17:19:51.000000000 +0100
@@ -114,8 +114,8 @@
static const int check_looplink = 1;
static int accept_dotfiles = 0;
static int find_explain = 0;
-/**
- * trim: remove blanks and @CODE{'\\'}.
+/*
+ * trim: remove blanks and '\'.
*/
static void
trim(char *s)
@@ -202,8 +202,8 @@
* prepare_skip: prepare skipping files.
*
* @par Globals used (output):
- * #listarray[]: skip list.
- * #list_count: count of skip list.
+ * listarray[]: skip list.
+ * list_count: count of skip list.
*
* @return compiled regular expression for skip files.
*/
@@ -382,7 +382,7 @@
/**
* issourcefile: check whether or not a source file.
*
- * @param[in] path path name (@STRONG{must} start with @FILE{./})
+ * @param[in] path path name (must start with "./")
* @return 1: source file, 0: other file
*/
int
@@ -400,13 +400,13 @@
/**
* skipthisfile: check whether or not we accept this file.
*
- * @param[in] path path name (@STRONG{must} start with @FILE{./})
+ * @param[in] path path name (must start with "./")
* @return 1: skip, 0: don't skip
*
* @attention
- * @STRONG{Specification of required path name:}
- * - Path @STRONG{must} start with @FILE{./}.
- * - Directory path name @STRONG{must} end with @FILE{/}.
+ * Specification of required path name:
+ * - Path must start with "./".
+ * - Directory path name must end with "/".
*/
int
skipthisfile(const char *path)
@@ -455,10 +455,9 @@
return 0;
}
-/**
- * @name Directory Stack
+/*
+ * Directory Stack
*/
-/** @{ */
static char dir[MAXPATHLEN]; /**< directory path */
static VARRAY *stack; /**< dynamic allocated array */
struct stack_entry {
@@ -467,7 +466,6 @@
char *dirp, *start, *end, *p;
};
static int current_entry; /**< current entry of the stack */
-/** @} */
/**
* getrealpath: return a real path of dir using allocated area.
@@ -482,9 +480,9 @@
return check_strdup(real);
}
/**
- * has_symlinkloop: whether or not @a dir has a symbolic link loops.
+ * has_symlinkloop: whether or not dir has a symbolic link loops.
*
- * @param[in] dir directory (@STRONG{should} end by @FILE{/})
+ * @param[in] dir directory (should end by "/")
* @return 1: has a loop, 0: don't have a loop
*/
int
@@ -527,7 +525,7 @@
/**
* getdirs: get directory list
*
- * @param[in] dir directory (@STRONG{should} end by @FILE{/})
+ * @param[in] dir directory (should end by "/")
* @param[out] sb string buffer
* @return -1: error, 0: normal
*
@@ -535,7 +533,7 @@
* @code
* |ddir1\0ffile1\0|
* @endcode
- * means directory @FILE{dir1}, file @FILE{file1}.
+ * means directory "dir1", file "file1".
*/
static int
getdirs(const char *dir, STRBUF *sb)
@@ -582,10 +580,10 @@
accept_dotfiles = 1;
}
/**
- * find_open: start iterator without @VAR{GPATH}.
+ * find_open: start iterator without GPATH.
*
- * @param[in] start start directory
- * If @VAR{NULL}, assumed @CODE{\".\"} directory.
+ * @param[in] start start directory,
+ * If NULL, assumed "." (current) directory.
* @param[in] explain print verbose message
*/
void
@@ -617,10 +615,10 @@
strlimcpy(cwddir, get_root(), sizeof(cwddir));
}
/**
- * find_open_filelist: find_open like interface for handling output of @XREF{find,1}.
+ * find_open_filelist: find_open like interface for handling output of find(1).
*
- * @param[in] filename file including list of file names.
- * When @FILE{-} is specified, read from standard input.
+ * @param[in] filename file including list of file names.
+ * When "-" is specified, read from standard input.
* @param[in] root root directory of source tree
* @param[in] explain print verbose message
*/
@@ -660,7 +658,7 @@
strlimcpy(cwddir, root, sizeof(cwddir));
}
/**
- * find_read: read path without @VAR{GPATH}.
+ * find_read: read path without GPATH.
*
* @return path
*/
@@ -681,7 +679,7 @@
return path;
}
/**
- * find_read_traverse: read path without @VAR{GPATH}.
+ * find_read_traverse: read path without GPATH.
*
* @return path
*/
diff -ur global-6.5-old/libutil/format.h global-7.7-new/libutil/format.h
--- global-6.5-old/libutil/format.h 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/format.h 2015-06-15 17:23:37.000000000 +0100
@@ -22,7 +22,7 @@
/**
* @file
* @par
- * (1) @NAME{ctags} -x format (#FORMAT_CTAGS_X)
+ * (1) ctags -x format (FORMAT_CTAGS_X)
*
* @par
* @code
@@ -31,9 +31,8 @@
* |main 227 ./src/main.c main()
* @endcode
*
- *
* @par
- * (2) @NAME{ctags} -x + file id format (#FORMAT_CTAGS_XID)
+ * (2) ctags -x + file id format (FORMAT_CTAGS_XID)
*
* @par
* @code
@@ -42,9 +41,8 @@
* |110 main 227 ./src/main.c main()
* @endcode
*
- *
* @par
- * (3) @NAME{ctags} format (#FORMAT_CTAGS)
+ * (3) ctags format (FORMAT_CTAGS)
*
* @par
* @code
@@ -52,9 +50,8 @@
* |main./src/main.c227
* @endcode
*
- *
* @par
- * (4) @NAME{ctags} format (#FORMAT_CTAGS_MOD)
+ * (4) ctags format (FORMAT_CTAGS_MOD)
*
* @par
* @code
@@ -62,9 +59,8 @@
* |./src/main.c227main()
* @endcode
*
- *
* @par
- * (5) path name format (#FORMAT_PATH)
+ * (5) path name format (FORMAT_PATH)
*
* @par
* @code
@@ -72,9 +68,8 @@
* |./src/main.c
* @endcode
*
- *
* @par
- * (6) @NAME{grep} format (#FORMAT_GREP)
+ * (6) grep format (FORMAT_GREP)
*
* @par
* @code
@@ -82,9 +77,8 @@
* |./src/main.c:227:main()
* @endcode
*
- *
* @par
- * (7) @NAME{cscope} line mode format (#FORMAT_CSCOPE)
+ * (7) cscope line mode format (FORMAT_CSCOPE)
*
* @par
* @code
@@ -101,26 +95,21 @@
#define FORMAT_GREP 6
#define FORMAT_CSCOPE 7
-/**
- * @name
- * #FORMAT_CTAGS_X
+/*
+ * FORMAT_CTAGS_X
*/
-/** @{ */
#define PART_TAG 0
#define PART_LNO 1
#define PART_PATH 2
#define PART_LINE 3
-/** @} */
-/**
- * @name Path name type
+/*
+ * Path name type
*/
-/** @{ */
#define PATH_RELATIVE 1
#define PATH_ABSOLUTE 2
#define PATH_THROUGH 3
#define PATH_SHORTER 4
#define PATH_ABSLIB 5
-/** @} */
#endif /* ! _FORMAT_H_ */
diff -ur global-6.5-old/libutil/getdbpath.c global-7.7-new/libutil/getdbpath.c
--- global-6.5-old/libutil/getdbpath.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/getdbpath.c 2015-06-15 17:25:29.000000000 +0100
@@ -60,7 +60,7 @@
char const *gtags_dbpath_error; /**< error message */
/**
- * setupvariables: load variables regard to @NAME{BSD} @NAME{OBJ} directory.
+ * setupvariables: load variables regard to BSD OBJ directory.
*/
static void
setupvariables(int verbose)
@@ -87,7 +87,7 @@
*
* @param[in] candidate candidate root directory
* @param[in] verbose verbose mode 1: on, 0: off
- * @return objdir(@VAR{NULL}: not found)
+ * @return objdir(NULL: not found)
*/
char *
getobjdir(const char *candidate, int verbose)
@@ -130,14 +130,14 @@
* gtagsexist: test whether GTAGS's existence.
*
* @param[in] candidate candidate root directory
- * @param[out] dbpath directory which @FILE{GTAGS} exist
- * @param[in] size size of @a dbpath buffer
+ * @param[out] dbpath directory which "GTAGS" exist
+ * @param[in] size size of dbpath buffer
* @param[in] verbose verbose mode 1: on, 0: off
* @return 0: not found, 1: found
*
- * Gtagsexist locate @FILE{GTAGS} file in @FILE{\$candidate/}, @FILE{\$candidate/obj/} and
- * @FILE{/usr/obj/\$candidate/} in this order by default.
- * This behavior is same with @NAME{BSD} @XREF{make,1}'s one.
+ * Gtagsexist locate "GTAGS" file in "$candidate/", "$candidate/obj/" and
+ * "/usr/obj/$candidate/" in this order by default.
+ * This behavior is same with BSD make(1)'s one.
*/
int
gtagsexist(const char *candidate, char *dbpath, int size, int verbose)
@@ -194,18 +194,18 @@
static char cwd[MAXPATHLEN];
static char nearbase[MAXPATHLEN];
static char relative_cwd_with_slash[MAXPATHLEN+2];
-/**
+/*
* setupdbpath: setup dbpath directory
*
* @param[in] verbose verbose mode 1: on, 0: off
*
* @par Globals used (output):
- * #cwd: current directory
- * #root: root of source tree
- * #dbpath: directory which @FILE{GTAGS} exist
- * #gtags_dbpath_error: set if status (return value) \< 0
+ * cwd: current directory,
+ * root: root of source tree,
+ * dbpath: directory which "GTAGS" exist,
+ * gtags_dbpath_error: set if status (return value) < 0
*
- * @return 0: normal, 0\<: error
+ * @return 0: normal, 0<: error
*/
int
setupdbpath(int verbose)
@@ -343,13 +343,13 @@
return 0;
}
/**
- * in_the_project: test whether @a path is in the project.
+ * in_the_project: test whether path is in the project.
*
* @param[in] path target file or directory
* @return 0: out of the project, 1: in the project
*
- * @note Please pass an absolute path name which does not include @FILE{.} (current directory) or
- * @FILE{..} (parent directory).
+ * @note Please pass an absolute path name which does not include "." (current directory) or
+ * ".." (parent directory).
*/
int
in_the_project(const char *path)
@@ -358,10 +358,9 @@
return 1;
return 0;
}
-/**
- * @name return saved values.
+/*
+ * return saved values.
*/
-/** @{ */
const char *
get_dbpath(void)
{
@@ -413,4 +412,3 @@
fprintf(stderr, "current directory: %s\n", cwd);
fprintf(stderr, "nearbase: %s\n", nearbase);
}
-/** @} */
diff -ur global-6.5-old/libutil/gpathop.c global-7.7-new/libutil/gpathop.c
--- global-6.5-old/libutil/gpathop.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/gpathop.c 2015-06-15 17:28:00.000000000 +0100
@@ -53,19 +53,19 @@
}
/**
* @file
- * @NAME{GPATH} format version
+ * GPATH format version
*
- * -# @XREF{gtags,1} bury version number in #GPATH.
- * -# @XREF{global,1} pick up the version number from #GPATH. If the number
- * is not acceptable version number then @NAME{global} give up work any more
- * and display error message.
- * -# If version number is not found then it assumes version 1.
- * -# @NAME{GPATH} version is independent with the other tag files.
+ * 1. gtags(1) bury version number in GPATH.
+ * 2. global(1) pick up the version number from GPATH. If the number
+ * is not acceptable version number then global give up work any more
+ * and display error message.
+ * 3. If version number is not found then it assumes version 1.
+ * 4. GPATH version is independent with the other tag files.
*
* @par [History of format version]
*
- * @NAME{GLOBAL-4.8.7} no idea about format version.
- * @NAME{GLOBAL-5.0} understand format version.
+ * GLOBAL-4.8.7 no idea about format version.
+ * GLOBAL-5.0 understand format version.
* support format version 2.
*
* - Format version 1
@@ -83,9 +83,9 @@
* - Format version 2
* @par
*
- * #GPATH has not only source files but also other files like @FILE{README}.
+ * GPATH has not only source files but also other files like "README".
* You can distinguish them by the flag following data value.
- * At present, the flag value is only @CODE{'o'} (other files).
+ * At present, the flag value is only 'o' (other files).
*
* @par
* @code{.txt}
@@ -100,11 +100,11 @@
/**
* gpath_open: open gpath tag file
*
- * @param[in] dbpath @VAR{GTAGSDBPATH}
- * @param[in] mode 0: read only
- * 1: create
+ * @param[in] dbpath GTAGSDBPATH
+ * @param[in] mode 0: read only,
+ * 1: create,
* 2: modify
- * @return 0: normal
+ * @return 0: normal,
* -1: error
*/
int
@@ -148,9 +148,9 @@
* gpath_put: put path name
*
* @param[in] path path name
- * @param[in] type path type
- * #GPATH_SOURCE: source file
- * #GPATH_OTHER: other file
+ * @param[in] type path type
+ * GPATH_SOURCE: source file,
+ * GPATH_OTHER: other file
*/
void
gpath_put(const char *path, int type)
@@ -184,9 +184,9 @@
* gpath_path2fid: convert path into id
*
* @param[in] path path name
- * @param[out] type path type
- * #GPATH_SOURCE: source file
- * #GPATH_OTHER: other file
+ * @param[out] type path type
+ * GPATH_SOURCE: source file,
+ * GPATH_OTHER: other file
* @return file id
*/
const char *
@@ -205,9 +205,9 @@
* gpath_fid2path: convert id into path
*
* @param[in] fid file id
- * @param[out] type path type
- * #GPATH_SOURCE: source file
- * #GPATH_OTHER: other file
+ * @param[out] type path type
+ * GPATH_SOURCE: source file,
+ * GPATH_OTHER: other file
* @return path name
*/
const char *
@@ -278,24 +278,24 @@
/**
* @fn GFIND *gfind_open(const char *dbpath, const char *local, int target)
*
- * @remark gfind iterator using #GPATH.
+ * @remark gfind iterator using GPATH.
*
* @par
- * @NAME{gfind_xxx()} does almost same with @NAME{find_xxx()} but much faster,
- * because @NAME{gfind_xxx()} use #GPATH (file index).
- * If #GPATH exist then you should use this.
+ * gfind_xxx() does almost same with find_xxx() but much faster,
+ * because gfind_xxx() use GPATH (file index).
+ * If GPATH exist then you should use this.
*/
/**
- * gfind_open: start iterator using #GPATH.
+ * gfind_open: start iterator using GPATH.
*
* @param[in] dbpath dbpath
- * @param[in] local local prefix
- * if @VAR{NULL} specified, it assumes @FILE{./};
- * @param[in] target #GPATH_SOURCE: only source file
- * #GPATH_OTHER: only other file
- * #GPATH_BOTH: source file + other file
- * @return #GFIND structure
+ * @param[in] local local prefix,
+ * if NULL specified, it assumes "./";
+ * @param[in] target GPATH_SOURCE: only source file,
+ * GPATH_OTHER: only other file,
+ * GPATH_BOTH: source file + other file
+ * @return GFIND structure
*/
GFIND *
gfind_open(const char *dbpath, const char *local, int target)
@@ -319,9 +319,9 @@
return gfind;
}
/**
- * gfind_read: read path using #GPATH.
+ * gfind_read: read path using GPATH.
*
- * @param[in] gfind #GFIND structure
+ * @param[in] gfind GFIND structure
* @return path
*/
const char *
diff -ur global-6.5-old/libutil/gpathop.h global-7.7-new/libutil/gpathop.h
--- global-6.5-old/libutil/gpathop.h 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/gpathop.h 2015-06-15 18:28:36.000000000 +0100
@@ -27,14 +27,12 @@
#define NEXTKEY " __.NEXTKEY"
-/**
- * @name File type
+/*
+ * File type
*/
-/** @{ */
#define GPATH_SOURCE 1
#define GPATH_OTHER 2
#define GPATH_BOTH 3
-/** @} */
typedef struct {
/** set by gfind_open() */
diff -ur global-6.5-old/libutil/gtagsop.c global-7.7-new/libutil/gtagsop.c
--- global-6.5-old/libutil/gtagsop.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/gtagsop.c 2015-06-15 17:34:50.000000000 +0100
@@ -176,11 +176,11 @@
/**
* Tag format
*
- * address@hidden of format version 6}]
+ * [Specification of format version 6]
*
* @par Standard format:
*
- * This format is the default format of #GTAGS.
+ * This format is the default format of GTAGS.
*
* @par
* @code{.txt}
@@ -199,14 +199,14 @@
* @endcode
*
* @par
- * Line image might be compressed (#GTAGS_COMPRESS).
- * Tag name might be compressed (#GTAGS_COMPNAME).
+ * Line image might be compressed (GTAGS_COMPRESS).
+ * Tag name might be compressed (GTAGS_COMPNAME).
*
* @par Compact format:
*
* @par
- * This format is the default format of #GRTAGS.
- * It is used for #GTAGS with the @OPTION{-c} option.
+ * This format is the default format of GRTAGS.
+ * It is used for GTAGS with the -c option.
*
* @par
* @code{.txt}
@@ -224,18 +224,18 @@
* @endcode
*
* @par
- * Line numbers are sorted in a line.
+ * Line numbers are sorted in a line.
* Each line number might be expressed as difference from the previous
- * line number except for the head (#GTAGS_COMPLINE).
- * ex: 10,3,2 means '10 13 15'.
- * In addition,successive line numbers are expressed as a range.
+ * line number except for the head (GTAGS_COMPLINE).
+ * ex: 10,3,2 means '10 13 15'.
+ * In addition,successive line numbers are expressed as a range.
* ex: 10-3 means '10 11 12 13'.
*
* @par [Description]
*
- * - Standard format is applied to #GTAGS, and compact format is applied
- * to #GRTAGS by default.
- * - #GSYMS is not used any longer. It is virtually included by GRTAGS.
+ * - Standard format is applied to GTAGS, and compact format is applied
+ * to GRTAGS by default.
+ * - GSYMS is not used any longer. It is virtually included by GRTAGS.
* - Above two formats are same to the first line number. So, we can use
* common function to sort them.
* - Separator is single blank.
@@ -249,20 +249,20 @@
*
* @par [Concept of format version]
*
- * Since @NAME{GLOBAL}'s tag files are machine independent, they can be distributed
- * apart from @NAME{GLOBAL} itself. For example, if some network file system available,
+ * Since GLOBAL's tag files are machine independent, they can be distributed
+ * apart from GLOBAL itself. For example, if some network file system available,
* client may execute global using server's tag files. In this case, both
- * @NAME{GLOBAL} are not necessarily the same version. So, we should assume that
- * older version of @NAME{GLOBAL} might access the tag files which generated
- * by new @NAME{GLOBAL}. To deal in such case, we decided to buried a version number
- * to both @XREF{global,1} and tag files. The conclete procedure is like follows:
+ * GLOBAL are not necessarily the same version. So, we should assume that
+ * older version of GLOBAL might access the tag files which generated
+ * by new GLOBAL. To deal in such case, we decided to buried a version number
+ * to both global(1) and tag files. The conclete procedure is like follows:
*
* @par
- * -# @XREF{gtags,1} bury the version number in tag files.
- * -# @XREF{global,1} pick up the version number from a tag file. If the number
+ * 1. gtags(1) bury the version number in tag files.
+ * 2. global(1) pick up the version number from a tag file. If the number
* is larger than its acceptable version number then global give up work
- * any more and display error message.
- * -# If version number is not found then it assumes version 1.
+ * any more and display error message.
+ * 3. If version number is not found then it assumes version 1.
*
* @par [History of format version]
*
@@ -283,7 +283,7 @@
if (format > 6 || format < 6) then print error message.
@endverbatim
*
- * In @NAME{GLOBAL-5.0}, we threw away the compatibility with the past formats.
+ * In GLOBAL-5.0, we threw away the compatibility with the past formats.
* Though we could continue the support for older formats, it seemed
* not to be worthy. Because keeping maintaining the all formats hinders
* new optimization and the function addition in the future.
@@ -302,10 +302,10 @@
static int lower_bound_version = 6; /**< acceptable format version (lower bound) */
static const char *const tagslist[] = {"GPATH", "GTAGS", "GRTAGS", "GSYMS"};
/**
- * Virtual #GRTAGS, #GSYMS processing:
+ * Virtual GRTAGS, GSYMS processing:
*
- * We use a real @NAME{GRTAGS} as virtual @NAME{GRTAGS} and @NAME{GSYMS}.
- * In fact, @NAME{GSYMS} tag file doesn't exist.
+ * We use a real GRTAGS as virtual GRTAGS and GSYMS.
+ * In fact, GSYMS tag file doesn't exist.
*
* @code{.txt}
* Real tag file virtual tag file
@@ -324,7 +324,7 @@
continue; \
}
/**
- * is_defined_in_GTAGS: whether or not the name is defined in #GTAGS.
+ * is_defined_in_GTAGS: whether or not the name is defined in GTAGS.
*
* @param[in] gtop
* @param[in] name tag name
@@ -346,7 +346,7 @@
/**
* dbname: return db name
*
- * @param[in] db 0: #GPATH, 1: #GTAGS, 2: #GRTAGS, 3: #GSYMS
+ * @param[in] db 0: GPATH, 1: GTAGS, 2: GRTAGS, 3: GSYMS
* @return dbname
*/
const char *
@@ -362,14 +362,14 @@
*
* @param[in] dbpath dbpath directory
* @param[in] root root directory (needed when compact format)
- * @param[in] db #GTAGS, #GRTAGS, #GSYMS
- * @param[in] mode #GTAGS_READ: read only
- * #GTAGS_CREATE: create tag
- * #GTAGS_MODIFY: modify tag
- * @param[in] flags #GTAGS_COMPACT: compact format
- * @return #GTOP structure
+ * @param[in] db GTAGS, GRTAGS, GSYMS
+ * @param[in] mode GTAGS_READ: read only,
+ * GTAGS_CREATE: create tag,
+ * GTAGS_MODIFY: modify tag
+ * @param[in] flags GTAGS_COMPACT: compact format
+ * @return GTOP structure
*
- * @note when error occurred, @NAME{gtags_open()} doesn't return.
+ * @note when error occurred, gtags_open() doesn't return.
*/
GTOP *
gtags_open(const char *dbpath, const char *root, int db, int mode, int flags)
@@ -515,7 +515,7 @@
/**
* gtags_put_using: put tag record with packing.
*
- * @param[in] gtop descripter of #GTOP
+ * @param[in] gtop descripter of GTOP
* @param[in] tag tag name
* @param[in] lno line number
* @param[in] fid file id
@@ -577,7 +577,7 @@
/**
* gtags_flush: Flush the pool for compact format.
*
- * @param[in] gtop descripter of #GTOP
+ * @param[in] gtop descripter of GTOP
* @param[in] fid file id
*/
void
@@ -591,7 +591,7 @@
/**
* gtags_delete: delete records belong to set of fid.
*
- * @param[in] gtop #GTOP structure
+ * @param[in] gtop GTOP structure
* @param[in] deleteset bit array of fid
*/
void
@@ -680,10 +680,10 @@
/**
* gtags_restart: restart dbop iterator using lower case prefix.
*
- * @param[in] gtop #GTOP structure
+ * @param[in] gtop GTOP structure
* @return prepared or not
- * #0: cannot continue
- * #1: can continue
+ * 0: cannot continue
+ * 1: can continue
*/
static int
gtags_restart(GTOP *gtop)
@@ -709,18 +709,18 @@
/**
* gtags_first: return first record
*
- * @param[in] gtop #GTOP structure
- * @param[in] pattern tag name
+ * @param[in] gtop GTOP structure
+ * @param[in] pattern tag name,
* - may be regular expression
- * - may be @VAR{NULL}
- * @param[in] flags #GTOP_PREFIX: prefix read
- * #GTOP_KEY: read key only
- * #GTOP_PATH: read path only
- * #GTOP_NOREGEX: don't use regular expression.
- * #GTOP_IGNORECASE: ignore case distinction.
- * #GTOP_BASICREGEX: use basic regular expression.
- * #GTOP_NEARSORT: use 'Nearness sort'.
- * #GTOP_NOSORT: don't sort
+ * - may be NULL
+ * @param[in] flags GTOP_PREFIX: prefix read,
+ * GTOP_KEY: read key only,
+ * GTOP_PATH: read path only,
+ * GTOP_NOREGEX: don't use regular expression.
+ * GTOP_IGNORECASE: ignore case distinction.
+ * GTOP_BASICREGEX: use basic regular expression.
+ * GTOP_NEARSORT: use 'Nearness sort'.
+ * GTOP_NOSORT: don't sort
*
* By default, sort is done by alphabetical order.
* @return record
@@ -936,9 +936,9 @@
/**
* gtags_next: return next record.
*
- * @param[in] gtop #GTOP structure
+ * @param[in] gtop GTOP structure
* @return record
- * @VAR{NULL} end of tag
+ * NULL end of tag
*/
GTP *
gtags_next(GTOP *gtop)
@@ -997,7 +997,7 @@
/**
* gtags_close: close tag file
*
- * @param[in] gtop #GTOP structure
+ * @param[in] gtop GTOP structure
*/
void
gtags_close(GTOP *gtop)
@@ -1023,7 +1023,7 @@
/**
* flush_pool: flush and write the pool as compact format.
*
- * @param[in] gtop descripter of #GTOP
+ * @param[in] gtop descripter of GTOP
* @param[in] s_fid
*/
static void
@@ -1153,14 +1153,14 @@
/**
* Read a tag segment with sorting.
*
- * @param[in] gtop #GTOP structure
- * Output: @CODE{gtop->gtp_array} segment table
- * Output: @CODE{gtop->gtp_count} segment table size
- * Output: @CODE{gtop->gtp_index} segment table index (initial value = 0)
- * Output: @CODE{gtop->cur_tagname} current tag name
+ * @param[in] gtop GTOP structure
+ * Output: gtop->gtp_array segment table
+ * Output: gtop->gtp_count segment table size
+ * Output: gtop->gtp_index segment table index (initial value = 0)
+ * Output: gtop->cur_tagname current tag name
*
- * A segment is a set of tag records which have same tag name.
- * This function read a segment from tag file, sort it and put it on segment table.
+ * A segment is a set of tag records which have same tag name.
+ * This function read a segment from tag file, sort it and put it on segment table.
* This function can treat both of standard format and compact format.
*
* Sorting is done by three keys.
diff -ur global-6.5-old/libutil/gtagsop.h global-7.7-new/libutil/gtagsop.h
--- global-6.5-old/libutil/gtagsop.h 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/gtagsop.h 2015-06-15 17:39:37.000000000 +0100
@@ -47,11 +47,9 @@
#define GTAGS_CREATE 1
#define GTAGS_MODIFY 2
-/**
- * @name
+/*
* Defines for gtags_open()
*/
-/** @{ */
/** compact option */
#define GTAGS_COMPACT 1
/** compression option */
@@ -65,16 +63,13 @@
/** use sqlite3 database */
#ifdef USE_SQLITE3
#define GTAGS_SQLITE3 32
- /** print information for debug */
#endif
+ /** print information for debug */
#define GTAGS_DEBUG 65536
-/** @} */
-/**
- * @name
+/*
* Defines for gtags_first()
*/
-/** @{ */
/** read key part */
#define GTOP_KEY 1
/** read path part */
@@ -91,7 +86,6 @@
#define GTOP_NEARSORT 64
/** don't sort */
#define GTOP_NOSORT 128
-/** @} */
/**
* This entry corresponds to one raw record.
@@ -104,49 +98,43 @@
} GTP;
typedef struct {
- DBOP *dbop; /**< descripter of #DBOP */
- DBOP *gtags; /**< descripter of #GTAGS */
+ DBOP *dbop; /**< descripter of DBOP */
+ DBOP *gtags; /**< descripter of GTAGS */
int format_version; /**< format version */
- int format; /**< #GTAGS_COMPACT, #GTAGS_COMPRESS */
+ int format; /**< GTAGS_COMPACT, GTAGS_COMPRESS */
int mode; /**< mode */
- int db; /**< 0:#GTAGS, 1:#GRTAGS, 2:#GSYMS */
+ int db; /**< 0:GTAGS, 1:GRTAGS, 2:GSYMS */
int openflags; /**< flags value of gtags_open() */
int flags; /**< flags */
char root[MAXPATHLEN]; /**< root directory of source tree */
- /**
- * Stuff for #GTOP_PATH.
+ /*
+ * Stuff for GTOP_PATH.
*/
- /** @{ */
- int path_count; /**< */
- int path_index; /**< */
- char **path_array; /**< */
- /** @} */
+ int path_count;
+ int path_index;
+ char **path_array;
- /**
+ /*
* Stuff for segment_read().
*/
- /** @{ */
- int gtp_count; /**< */
- int gtp_index; /**< */
- GTP *gtp_array; /**< */
- GTP gtp; /**< */
- POOL *segment_pool; /**< */
- VARRAY *vb; /**< */
+ int gtp_count;
+ int gtp_index;
+ GTP *gtp_array;
+ GTP gtp;
+ POOL *segment_pool;
+ VARRAY *vb;
char cur_tagname[IDENTLEN]; /**< current tag name */
- /** @} */
- /**
+ /*
* Stuff for compact format
*/
- /** @{ */
STRBUF *sb; /**< string buffer */
- /** @} */
/** used for compact format and path name only read */
STRHASH *path_hash;
- /**
+ /*
* Stuff for calling dbop
*/
const char *key;
diff -ur global-6.5-old/libutil/idset.c global-7.7-new/libutil/idset.c
--- global-6.5-old/libutil/idset.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/idset.c 2015-06-15 17:45:01.000000000 +0100
@@ -35,9 +35,9 @@
/** maybe 32 or 64 */
#define LONG_BIT (sizeof(long) * CHAR_BIT)
-/**
- * @CODE{idset->min} is initialized to #END_OF_ID.
- * (You may use @CODE{idset->max} instead of @CODE{idset->min}.)
+/*
+ * idset->min is initialized to END_OF_ID.
+ * (You may use idset->max instead of idset->min.)
*/
#define IS_EMPTY(idset) ((idset)->min == END_OF_ID ? 1 : 0)
@@ -62,8 +62,8 @@
idset_close(idset) []
@endcode
-Idset's index always start from 0 according to the custom of C language.
-I you want to treat 1-20 then you @EMPH{must} invoke idset_open() with a argument 21.
+Idset's index always start from 0 according to the custom of C language.
+I you want to treat 1-20 then you must invoke idset_open() with a argument 21.
@code
idset = idset_open(21);
@@ -74,8 +74,8 @@
idset_add(idset, 21); => ERROR (idset_add: id is out of range.)
@endcode
-The range of value is from 0 to the maximum value expressible by unsigned integer - 1.
-You should define index as an unsigned integer, and use #END_OF_ID like follows:
+The range of value is from 0 to the maximum value expressible by unsigned integer - 1.
+You should define index as an unsigned integer, and use END_OF_ID like follows:
@code
unsigned int id;
@@ -113,7 +113,7 @@
return idset;
}
/**
- * Return true if @a idset is empty.
+ * Return true if idset is empty.
*
* @param[in] idset idset structure
* @return 1: empty, 0: not empty
@@ -124,7 +124,7 @@
return IS_EMPTY(idset);
}
/**
- * Add @a id to the @a idset.
+ * Add id to the idset.
*
* @param[in] idset idset structure
* @param[in] id id number
@@ -145,7 +145,7 @@
idset->min = id;
}
/**
- * Whether or not @a idset includes specified @a id.
+ * Whether or not idset includes specified id.
*
* @param[in] idset idset structure
* @param[in] id id number
@@ -164,7 +164,7 @@
* Get first id.
*
* @param[in] idset idset structure
- * @return id (#END_OF_ID: end of id)
+ * @return id (END_OF_ID: end of id)
*
*/
unsigned int
@@ -178,7 +178,7 @@
* Get next id.
*
* @param[in] idset idset structure
- * @return id (#END_OF_ID: end of id)
+ * @return id (END_OF_ID: end of id)
*
*/
unsigned int
diff -ur global-6.5-old/libutil/is_unixy.c global-7.7-new/libutil/is_unixy.c
--- global-6.5-old/libutil/is_unixy.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/is_unixy.c 2015-06-14 14:47:12.000000000 +0100
@@ -32,9 +32,9 @@
#include "is_unixy.h"
/**
- * is_unixy: whether running in a @NAME{unix}-like shell or not
+ * is_unixy: whether running in a unix-like shell or not
*
- * @return 1: unixy shell, 0: @NAME{DOS} shell (@FILE{COMMAND.COM})
+ * @return 1: unixy shell, 0: DOS shell ("COMMAND.COM")
*/
int
is_unixy(void)
diff -ur global-6.5-old/libutil/langmap.c global-7.7-new/libutil/langmap.c
--- global-6.5-old/libutil/langmap.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/langmap.c 2015-06-14 14:46:12.000000000 +0100
@@ -42,7 +42,7 @@
/**
* construct language map.
*
- * copy string langmap (@a map) and convert it to language map like this:
+ * copy string langmap (map) and convert it to language map like this:
*
* @code{.txt}
* langmap (string) "c:.c.h,java:.java,cpp:.C.H"
@@ -76,12 +76,12 @@
}
/**
- * decide the language of the @a suffix.
+ * decide the language of the suffix.
*
* @remark
- * Though @FILE{*.h} files are shared by C and C++, @NAME{GLOBAL} treats them
+ * Though '*.h' files are shared by C and C++, GLOBAL treats them
* as C source files by default. If you set an environment variable
- * @FILE{GTAGSFORCECPP} then C++ parser will be invoked.
+ * 'GTAGSFORCECPP' then C++ parser will be invoked.
*/
const char *
decide_lang(const char *suffix)
@@ -110,7 +110,7 @@
}
/**
- * return true if the @a suffix matches with one in the @a list.
+ * return true if the suffix matches with one in the list.
*/
static int
match_suffix_list(const char *suffix, const char *list)
@@ -131,7 +131,7 @@
}
/**
- * make suffix value from @a langmap value.
+ * make suffix value from langmap value.
*/
void
make_suffixes(const char *langmap, STRBUF *sb)
diff -ur global-6.5-old/libutil/linetable.c global-7.7-new/libutil/linetable.c
--- global-6.5-old/libutil/linetable.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/linetable.c 2015-06-15 17:48:15.000000000 +0100
@@ -35,19 +35,15 @@
#include "varray.h"
#include "strbuf.h"
-/** @name File buffer */
-/** @{ */
+/* File buffer */
#define EXPAND 1024
static STRBUF *ib;
static char *filebuf;
static int filesize;
-/** @} */
-/** @name File pointer */
-/** @{ */
+/* File pointer */
static char *curp;
static char *endp;
-/** @} */
/** Offset table */
static VARRAY *vb;
@@ -57,7 +53,7 @@
* linetable_open: load whole of file into memory.
*
* @param[in] path path
- * @return 0: normal
+ * @return 0: normal,
* -1: cannot open file.
*/
int
@@ -90,11 +86,11 @@
return 0;
}
/**
- * linetable_read: @XREF{read,2} compatible routine for linetable.
+ * linetable_read: read(2) compatible routine for linetable.
*
* @param[in,out] buf read buffer
* @param[in] size buffer size
- * @return ==-1: end of file
+ * @return ==-1: end of file,
* !=-1: number of bytes actually read
*/
int
@@ -115,7 +111,7 @@
* linetable_put: put a line into table.
*
* @param[in] offset offset of the line
- * @param[in] lineno line number of the line (\>= 1)
+ * @param[in] lineno line number of the line (>= 1)
*/
void
linetable_put(int offset, int lineno)
@@ -130,9 +126,9 @@
/**
* linetable_get: get a line from table.
*
- * @param[in] lineno line number of the line (\>= 1)
- * @param[out] offset offset of the line
- * if @CODE{offset == NULL}, nothing returned.
+ * @param[in] lineno line number of the line (>= 1)
+ * @param[out] offset offset of the line,
+ * if offset == NULL, nothing returned.
* @return line pointer
*/
char *
@@ -160,7 +156,7 @@
* linetable_print: print a line.
*
* @param[in] op output file pointer
- * @param[in] lineno line number (\>= 1)
+ * @param[in] lineno line number (>= 1)
*/
void
linetable_print(FILE *op, int lineno)
diff -ur global-6.5-old/libutil/locatestring.c global-7.7-new/libutil/locatestring.c
--- global-6.5-old/libutil/locatestring.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/locatestring.c 2015-06-14 14:37:25.000000000 +0100
@@ -73,7 +73,7 @@
/**
* strincmp: strncmp with ignoring case.
*
- * Interface is same with @NAME{strncmp}.
+ * Interface is same with strncmp.
*/
static int
strincmp(const char *string, const char *pattern, size_t len)
@@ -102,15 +102,15 @@
*
* @param[in] string string
* @param[in] pattern pattern
- * @param[in] flag MATCH_FIRST: match first
- * MATCH_AT_FIRST: match only at first column
- * MATCH_LAST: match last
- * MATCH_AT_LAST: match only at last column
- * MATCH_COMPLETE match completely
+ * @param[in] flag MATCH_FIRST: match first,
+ * MATCH_AT_FIRST: match only at first column,
+ * MATCH_LAST: match last,
+ * MATCH_AT_LAST: match only at last column,
+ * MATCH_COMPLETE match completely,
* IGNORE_CASE: Ignore case
* @return pointer or NULL
- * If the flag == MATCH_AT_FIRST then the pointer
- * points the following character of the matched
+ * If the flag == MATCH_AT_FIRST then the pointer
+ * points the following character of the matched
* string, else points at the head of it.
*
* This function is made to avoid compatibility problems.
diff -ur global-6.5-old/libutil/logging.c global-7.7-new/libutil/logging.c
--- global-6.5-old/libutil/logging.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/logging.c 2015-06-14 14:35:41.000000000 +0100
@@ -72,19 +72,19 @@
/**
* logging_printf: print a message into the logging file.
*
- * @param[in] s @NAME{printf} style format (fmt) string
+ * @param[in] s printf style format (fmt) string
*
* @remark
* Log messages are appended to the logging file; which is opened using
- * @CODE{'fopen(xx, \"a\")'} on the first call to logging_printf() or
- * logging_arguments().
+ * 'fopen(xx, "a")' on the first call to logging_printf() or
+ * logging_arguments().
* The logging file's filename should be in the OS environment variable
- * @FILE{GTAGSLOGGING}.
- * If @FILE{GTAGSLOGGING} is not setup or the logging file cannot be
+ * "GTAGSLOGGING".
+ * If "GTAGSLOGGING" is not setup or the logging file cannot be
* opened, logging is disabled; logging_printf() and logging_arguments()
* then do nothing.
*
- * @note The logging file stays @EMPH{open} for the life of the progam.
+ * @note The logging file stays open for the life of the progam.
*/
void
logging_printf(const char *s, ...)
diff -ur global-6.5-old/libutil/makepath.c global-7.7-new/libutil/makepath.c
--- global-6.5-old/libutil/makepath.c 2015-06-10 02:45:09.000000000 +0100
+++ global-7.7-new/libutil/makepath.c 2015-06-18 19:58:53.000000000 +0100
@@ -36,26 +36,26 @@
* @details
* makepath: make path from directory and file.
*
- * @param[in] dir directory(optional), @CODE{NULL} if not used.
+ * @param[in] dir directory(optional), NULL if not used.
* @param[in] file file
- * @param[in] suffix suffix(optional), @CODE{NULL} if not used.
+ * @param[in] suffix suffix(optional), NULL if not used.
* @return path
*
* @note Only makes a name, no real directories or files are created.
*
- * The path in argument @a dir can be an absoulute or relative one (@EMPH{Not sure if
- * can be relative one on WIN32}).
- * A @CODE{'.'} (dot) will be added to the @a suffix (file extension) argument,
- * if not already present. Any existing suffix within @a file will not be removed.
- * A separator (@CODE{'/'} or @CODE{'\\'}) will be added to @a dir, if not present,
- * then @a file is appended to the end of @a dir. @a file and @a dir are used as
+ * The path in argument dir can be an absoulute or relative one (Not sure if
+ * can be relative one on WIN32).
+ * A '.' (dot) will be added to the suffix (file extension) argument,
+ * if not already present. Any existing suffix within file will not be removed.
+ * A separator ('/' or '\\') will be added to dir, if not present,
+ * then file is appended to the end of dir. file and dir are used as
* given. None of the paths given or generated are checked for validity, but they
- * are checked for size (#MAXPATHLEN), (calls die() if too big).
+ * are checked for size (MAXPATHLEN), (calls die() if too big).
*
* @attention
- * It is necessary to note the usage of @NAME{makepath()}, because it returns
- * module local area. If @NAME{makepath()} is called again in the function which
- * is passed the return value of @NAME{makepath()}, then the value is overwritten.
+ * It is necessary to note the usage of makepath(), because it returns
+ * module local area. If makepath() is called again in the function which
+ * is passed the return value of makepath(), then the value is overwritten.
* This may cause the bug which is not understood easily.
* You must not pass the return value except for the safe functions
* described below.
@@ -63,7 +63,7 @@
* @attention
* Here are safe functions.
* - functions in standard C library.
- * - following libutil functions:
+ * - following libutil functions:
* test(), dbop_open(), strlimcpy(), strbuf_puts(), die()
*/
const char *
diff -ur global-6.5-old/libutil/path.c global-7.7-new/libutil/path.c
--- global-6.5-old/libutil/path.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/path.c 2015-06-14 14:29:45.000000000 +0100
@@ -168,7 +168,7 @@
*
* @param[in] in_path
* @param[out] out_path result string
- * @return @a out_path
+ * @return out_path
*/
char *
realpath(const char *in_path, char *out_path)
@@ -195,14 +195,14 @@
#define SEP '/'
/**
- * makedirectories: make directories on the path like @XREF{mkdir,1} with the @OPTION{-p} option.
+ * makedirectories: make directories on the path like mkdir(1) with the -p option.
*
* @param[in] base base directory
* @param[in] rest path from the base
* @param[in] verbose 1: verbose mode, 0: not verbose mode
- * @return 0: success
- * -1: base directory not found
- * -2: permission error
+ * @return 0: success,
+ * -1: base directory not found,
+ * -2: permission error,
* -3: cannot make directory
*
* @remark Directories are created in mode 0775.
@@ -245,7 +245,7 @@
/**
* trimpath: trim path name
*
- * @remark Just skips over @CODE{"./"} at the beginning of @a path, if present.
+ * @remark Just skips over "./" at the beginning of path, if present.
*/
const char *
trimpath(const char *path)
@@ -258,8 +258,8 @@
* get the current directory
*
* @param[out] buf result string
- * @param[in] size size of @a buf
- * @return @a buf or NULL
+ * @param[in] size size of buf
+ * @return buf or NULL
*/
char *
vgetcwd(char *buf, size_t size) {
diff -ur global-6.5-old/libutil/path.h global-7.7-new/libutil/path.h
--- global-6.5-old/libutil/path.h 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/path.h 2015-06-15 18:26:50.000000000 +0100
@@ -26,7 +26,7 @@
#endif
/**
- * #PATHSEP - Define OS-specific directory and path separators
+ * PATHSEP - Define OS-specific directory and path separators
*/
#if (defined(_WIN32) && !defined(__CYGWIN__)) || defined(__DJGPP__)
#define PATHSEP ";"
diff -ur global-6.5-old/libutil/pool.c global-7.7-new/libutil/pool.c
--- global-6.5-old/libutil/pool.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/pool.c 2015-06-15 17:54:25.000000000 +0100
@@ -50,7 +50,7 @@
/**
* pool_open: open memory pool
*
- * @return pool #POOL structure
+ * @return pool POOL structure
*/
POOL *
pool_open(void)
@@ -64,7 +64,7 @@
/**
* pool_malloc: allocate memory from pool
*
- * @param[in] pool #POOL structure
+ * @param[in] pool POOL structure
* @param[in] size memory size
* @return allocated memory
*/
@@ -74,9 +74,9 @@
return obstack_alloc(&pool->obstack, size);
}
/**
- * pool_strdup: memory pool version of @NAME{strdup()}
+ * pool_strdup: memory pool version of strdup()
*
- * @param[in] pool #POOL structure
+ * @param[in] pool POOL structure
* @param[in] string string
* @param[in] size
* @return allocated memory
@@ -89,9 +89,9 @@
return obstack_copy0(&pool->obstack, string, size);
}
/**
- * pool_strdup_withterm: memory pool version of @NAME{strdup()}
+ * pool_strdup_withterm: memory pool version of strdup()
*
- * @param[in] pool #POOL structure
+ * @param[in] pool POOL structure
* @param[in] string string
* @param[in] term terminate character
* @return allocated memory
@@ -106,7 +106,7 @@
/**
* pool_reset: reset memory pool
*
- * @param[in] pool #POOL structure
+ * @param[in] pool POOL structure
*/
void
pool_reset(POOL *pool)
@@ -119,7 +119,7 @@
/**
* pool_close: close memory pool
*
- * @param[in] pool #POOL structure
+ * @param[in] pool POOL structure
*/
void
pool_close(POOL *pool)
diff -ur global-6.5-old/libutil/rewrite.c global-7.7-new/libutil/rewrite.c
--- global-6.5-old/libutil/rewrite.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/rewrite.c 2015-06-15 17:55:31.000000000 +0100
@@ -34,8 +34,8 @@
/** @file
Rewrite: sed style rewriting module.
-usage:
-
address@hidden usage:
address@hidden
REWRITE *rewrite = rewrite_open("xyz", "<&>", 0);
rewrite_string(rewrite, "xyzABCxzy", 0);
@@ -49,6 +49,7 @@
=> xxxyyy
rewrite_close(rewrite);
address@hidden
*/
/**
* rewrite_open: open rewrite object
@@ -57,7 +58,7 @@
* accepts NULL
* @param[in] replace (allows '&')
* @param[in] flags for regcomp(3)
- * @return rewrite #REWRITE structure
+ * @return rewrite REWRITE structure
* NULL: invalid regular expression
*/
REWRITE *
@@ -119,7 +120,7 @@
* NULL: just print string
* @param[in] string
* @param[in] offset start point of the rewriting
- * @param[in] file descriptor
+ *
*/
const char *
rewrite_string(REWRITE *rewrite, const char *string, int offset)
diff -ur global-6.5-old/libutil/split.c global-7.7-new/libutil/split.c
--- global-6.5-old/libutil/split.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/split.c 2015-06-14 14:17:09.000000000 +0100
@@ -25,7 +25,7 @@
#include "die.h"
/** @file
- * Substring manager like @NAME{perl}'s @NAME{split}.
+ * Substring manager like perl's split.
*
* @code
* Initial status.
@@ -33,7 +33,7 @@
* line |main 100 ./main.c main(argc, argv)\n
* @endcode
*
- * The result of @CODE{split(line, 4, &list)}:
+ * The result of split(line, 4, &list):
*
* @code
* +------------------------------------------------------
@@ -59,7 +59,7 @@
* +---------+ =
* @endcode
*
- * The result of @CODE{split(line, 2, &list)}:
+ * The result of split(line, 2, &list):
*
* @code
* +------------------------------------------------------
@@ -83,7 +83,7 @@
* line |main 100 ./main.c main(argc, argv)\n
* @endcode
*
- * Recover() recover initial status of line with saved char in @NAME{savec}.
+ * Recover() recover initial status of line with saved char in savec.
*/
#define isblank(c) ((c) == ' ' || (c) == '\t')
@@ -165,12 +165,12 @@
}
}
/**
- * parse_xid: extract fid from @a ctags_xid format record.
+ * parse_xid: extract fid from ctags_xid format record.
*
* @param[in] ctags_xid ctags-xid record
- * @param[out] s_fid file id(string) if not @VAR{NULL}
- * @param[out] n_fid file id(integer) if not @VAR{NULL}
- * @return pointer to the @NAME{ctags_x} part
+ * @param[out] s_fid file id(string) if not NULL
+ * @param[out] n_fid file id(integer) if not NULL
+ * @return pointer to the ctags_x part
*/
const char *
parse_xid(const char *ctags_xid, char *s_fid, int *n_fid)
diff -ur global-6.5-old/libutil/strbuf.c global-7.7-new/libutil/strbuf.c
--- global-6.5-old/libutil/strbuf.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/strbuf.c 2015-06-15 15:48:50.000000000 +0100
@@ -43,7 +43,7 @@
String buffer: usage and memory status
- [xxx]: string buffer
+ [xxx]: string buffer
'v': current pointer
@code
@@ -82,7 +82,7 @@
/**
* __strbuf_expandbuf: expand buffer so that afford to the length data at least.
*
- * @param[in] sb #STRBUF structure
+ * @param[in] sb STRBUF structure
* @param[in] length required room
*/
void
@@ -102,9 +102,9 @@
/**
* strbuf_open: open string buffer.
*
- * @param[in] init initial buffer size
- * if 0 (zero) is specified then use default value (#INITIALSIZE).
- * @return sb #STRBUF structure
+ * @param[in] init initial buffer size
+ * if 0 (zero) is specified then use default value (INITIALSIZE).
+ * @return sb STRBUF structure
*/
STRBUF *
strbuf_open(int init)
@@ -134,7 +134,7 @@
* @param[in] sb statically defined string buffer
*
* This function is used for the initializing of static string buffer.
- * For the detail, see STATIC_STRBUF(sb) macro in @FILE{strbuf.h}.
+ * For the detail, see STATIC_STRBUF(sb) macro in "strbuf.h".
*/
void
strbuf_clear(STRBUF *sb)
@@ -153,7 +153,7 @@
/**
* strbuf_nputs: Put string with length
*
- * @param[in] sb string buffer
+ * @param[in,out] sb string buffer
* @param[in] s string
* @param[in] len length of string
*/
@@ -168,11 +168,11 @@
}
}
/**
- * strbuf_nputc: Put a character, @a len (number) times
+ * strbuf_nputc: Put a character, len (number) times
*
- * @param[in] sb string buffer
+ * @param[in,out] sb string buffer
* @param[in] c character
- * @param[in] len number of times to put @a c
+ * @param[in] len number of times to put c
*
* @see strbuf_putc()
*/
@@ -189,7 +189,7 @@
/**
* strbuf_puts: Put string
*
- * @param[in] sb string buffer
+ * @param[in,out] sb string buffer
* @param[in] s string
*/
void
@@ -204,10 +204,9 @@
/**
* strbuf_puts_withterm: Put string until the terminator
*
- * @param[in] sb string buffer
+ * @param[in,out] sb string buffer
* @param[in] s string
* @param[in] c terminator
- * @return pointer to the terminator
*/
void
strbuf_puts_withterm(STRBUF *sb, const char *s, int c)
@@ -221,7 +220,7 @@
/**
* strbuf_puts_nl: Put string with a new line
*
- * @param[in] sb string buffer
+ * @param[in,out] sb string buffer
* @param[in] s string
*/
void
@@ -239,7 +238,7 @@
/**
* strbuf_putn: put digit string at the last of buffer.
*
- * @param[in] sb #STRBUF structure
+ * @param[in,out] sb STRBUF structure
* @param[in] n number
*/
void
@@ -264,7 +263,7 @@
/**
* strbuf_putn64: put digit string at the last of buffer.
*
- * @param[in] sb #STRBUF structure
+ * @param[in,out] sb STRBUF structure
* @param[in] n number
*/
void
@@ -289,7 +288,7 @@
/**
* strbuf_unputc: remove specified char from the last of buffer
*
- * @param[in] sb #STRBUF structure
+ * @param[in,out] sb STRBUF structure
* @param[in] c character
* @return 0: do nothing, 1: removed
*/
@@ -305,7 +304,7 @@
/**
* strbuf_value: return the content of string buffer.
*
- * @param[in] sb #STRBUF structure
+ * @param[in] sb STRBUF structure
* @return string
*/
char *
@@ -317,7 +316,7 @@
/**
* strbuf_trim: trim following blanks.
*
- * @param[in] sb #STRBUF structure
+ * @param[in,out] sb STRBUF structure
*/
void
strbuf_trim(STRBUF *sb)
@@ -328,20 +327,20 @@
*--p = 0;
sb->curp = p;
}
-/**
+/*
* strbuf_fgets: read whole record into string buffer
*
- * @param[out] sb string buffer
+ * @param[in,out] sb string buffer
* @param[in] ip input stream
- * @param[in] flags flags
- * #STRBUF_NOCRLF: remove last @CODE{'\\n'} and/or @CODE{'\\r'} if exist.
- * #STRBUF_APPEND: append next record to existing data
- * #STRBUF_SHARPSKIP: skip lines which start with @CODE{'\#'}
- * @return record buffer (@VAR{NULL} at end of file)
- *
- * Returned buffer has whole record.
- * The buffer end with @CODE{'\\0'}. If #STRBUF_NOCRLF is set then buffer doesn't
- * include @CODE{'\\r'} and @CODE{'\\n'}.
+ * @param[in] flags flags
+ * STRBUF_NOCRLF: remove last '\n' and/or '\r' if exist.
+ * STRBUF_APPEND: append next record to existing data
+ * STRBUF_SHARPSKIP: skip lines which start with '#'
+ * @return record buffer (NULL at end of file)
+ *
+ * Returned buffer has whole record.
+ * The buffer end with '\0'. If STRBUF_NOCRLF is set then buffer doesn't
+ * include '\r' and '\n'.
*/
char *
strbuf_fgets(STRBUF *sb, FILE *ip, int flags)
@@ -376,13 +375,13 @@
}
return sb->sbuf;
}
-/**
- * strbuf_sprintf: do @NAME{sprintf} into string buffer.
+/*
+ * strbuf_sprintf: do sprintf into string buffer.
*
- * @param[in] sb #STRBUF structure
- * @param[in] s similar to @NAME{sprintf()}
- * Currently the following format is supported.
- * @CODE{\%s, \%d, \%\d, \%\s, \%-\d, \%-\s}
+ * @param[in,out] sb STRBUF structure
+ * @param[in] s similar to sprintf()
+ * Currently the following format is supported.
+ * %s, %d, %d, %s, %-d, %-s
*/
void
strbuf_sprintf(STRBUF *sb, const char *s, ...)
@@ -393,14 +392,14 @@
strbuf_vsprintf(sb, s, ap);
va_end(ap);
}
-/**
- * strbuf_vsprintf: do @NAME{vsprintf} into string buffer.
+/*
+ * strbuf_vsprintf: do vsprintf into string buffer.
*
- * @param[in] sb #STRBUF structure
- * @param[in] s similar to @NAME{vsprintf()}
- * Currently the following format is supported.
- * @CODE{\%s, \%d, \%\d, \%\s, \%-\d, \%-\s}
- * @param[in] ap
+ * @param[in,out] sb STRBUF structure
+ * @param[in] s similar to vsprintf()
+ * Currently the following format is supported.
+ * %s, %d, %d, %s, %-d, %-s
+ * @param[in] ap
*/
void
strbuf_vsprintf(STRBUF *sb, const char *s, va_list ap)
@@ -467,7 +466,7 @@
/**
* strbuf_close: close string buffer.
*
- * @param[in] sb #STRBUF structure
+ * @param[in] sb STRBUF structure
*/
void
strbuf_close(STRBUF *sb)
@@ -505,6 +504,10 @@
strbuf_clear(sb);
return sb;
}
+
+/**
+ * @note this function is for use with strbuf_open_tempbuf() only.
+ */
void
strbuf_release_tempbuf(STRBUF *sb)
{
diff -ur global-6.5-old/libutil/strbuf.h global-7.7-new/libutil/strbuf.h
--- global-6.5-old/libutil/strbuf.h 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/strbuf.h 2015-06-15 18:00:02.000000000 +0100
@@ -47,18 +47,15 @@
#define INITIALSIZE 80
#define EXPANDSIZE 80
-/**
- * @name Defines for strbuf_fgets()
- * See: strbuf_fgets()
+/*
+ * Defines for strbuf_fgets()
*/
-/** @{ */
/** append next record to existing data. */
#define STRBUF_APPEND 1
- /** remove last @CODE{'\\n'} and/or @CODE{'\\r'}, if exists. */
+ /* remove last '\n' and/or '\r', if exists. */
#define STRBUF_NOCRLF 2
- /** skip lines which start with @CODE{'\#'} */
+ /* skip lines which start with '#' */
#define STRBUF_SHARPSKIP 4
-/** @} */
typedef struct _strbuf {
char *name;
@@ -73,11 +70,11 @@
*
* This macro is used for static string buffer which is suitable for
* work area and(or) return value of function. The area allocated once
- * is repeatedly used though the area is never released.
+ * is repeatedly used though the area is never released.
*
* @attention
- * You must call strbuf_clear() every time before using.
- * You must @STRONG{not} call strbuf_close() for it.
+ * You must call strbuf_clear() every time before using.
+ * You must not call strbuf_close() for it.
*
* @par Usage:
* @code
diff -ur global-6.5-old/libutil/strhash.c global-7.7-new/libutil/strhash.c
--- global-6.5-old/libutil/strhash.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/strhash.c 2015-06-15 18:02:54.000000000 +0100
@@ -79,7 +79,7 @@
* strhash_open: open string hash table.
*
* @param[in] buckets size of bucket table
- * @return sh #STRHASH structure
+ * @return sh STRHASH structure
*/
STRHASH *
strhash_open(int buckets)
@@ -98,14 +98,14 @@
/**
* strhash_assign: assign hash entry.
*
- * @param[in] sh #STRHASH structure
+ * @param[in] sh STRHASH structure
* @param[in] name name
* @param[in] force if entry not found, create it.
* @return pointer of the entry
*
- * If specified entry is found then it is returned, else if the @CODE{force == 1}
- * then new allocated entry is returned.
- * This procedure doesn't operate the contents of @CODE{entry->value}.
+ * If specified entry is found then it is returned, else if the force == 1
+ * then new allocated entry is returned.
+ * This procedure doesn't operate the contents of entry->value.
*/
struct sh_entry *
strhash_assign(STRHASH *sh, const char *name, int force)
@@ -134,7 +134,7 @@
/**
* strhash_strdup: allocate memory and copy string.
*
- * @param[in] sh #STRHASH structure
+ * @param[in] sh STRHASH structure
* @param[in] string string
* @param[in] size size of string
* @return allocated string
@@ -148,7 +148,7 @@
/**
* strhash_first: get first entry
*
- * @param[in] sh #STRHASH structure
+ * @param[in] sh STRHASH structure
*/
struct sh_entry *
strhash_first(STRHASH *sh)
@@ -160,7 +160,7 @@
/**
* strhash_next: get next entry
*
- * @param[in] sh #STRHASH structure
+ * @param[in] sh STRHASH structure
*/
struct sh_entry *
strhash_next(STRHASH *sh)
@@ -183,7 +183,7 @@
/**
* strhash_reset: reset string hash.
*
- * @param[in] sh #STRHASH structure
+ * @param[in] sh STRHASH structure
*/
void
strhash_reset(STRHASH *sh)
@@ -205,7 +205,7 @@
/**
* strhash_close: close hash array.
*
- * @param[in] sh #STRHASH structure
+ * @param[in] sh STRHASH structure
*/
void
strhash_close(STRHASH *sh)
diff -ur global-6.5-old/libutil/strlimcpy.c global-7.7-new/libutil/strlimcpy.c
--- global-6.5-old/libutil/strlimcpy.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/strlimcpy.c 2015-06-18 19:53:01.000000000 +0100
@@ -28,13 +28,13 @@
*
* @param[out] dest destination string
* @param[in] source source string
- * @param[in] limit size of @a dest
+ * @param[in] limit size of dest
*
- * @note This function is similar to @NAME{strlcpy()} of @NAME{OpenBSD} but is different
- * because @NAME{strlimcpy} abort when it beyond the limit.
+ * @note This function is similar to strlcpy() of OpenBSD but is different
+ * because strlimcpy abort when it beyond the limit.
*/
void
-strlimcpy(char *dest, const char *const source, const int limit)
+strlimcpy(char *dest, const char *const source, int limit)
{
int n = (int)limit;
const char *s = source;
diff -ur global-6.5-old/libutil/strlimcpy.h global-7.7-new/libutil/strlimcpy.h
--- global-6.5-old/libutil/strlimcpy.h 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/strlimcpy.h 2015-06-18 19:53:57.000000000 +0100
@@ -20,6 +20,6 @@
#ifndef _STRLIMCPY_H_
#define _STRLIMCPY_H_
-void strlimcpy(char *, const char *, const int);
+void strlimcpy(char *, const char *, int);
#endif /* ! _STRLIMCPY_H_ */
diff -ur global-6.5-old/libutil/strmake.c global-7.7-new/libutil/strmake.c
--- global-6.5-old/libutil/strmake.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/strmake.c 2015-06-15 18:04:52.000000000 +0100
@@ -64,12 +64,12 @@
* strtrim: make string from original string with deleting blanks.
*
* @param[in] p original string.
- * @param[in] flag #TRIM_HEAD: from only head
- * #TRIM_TAIL: from only tail
- * #TRIM_BOTH: from head and tail
- * #TRIM_ALL: from all
- * @param[out] len length of result string
- * if @CODE{len == NULL} then nothing returned.
+ * @param[in] flag TRIM_HEAD: from only head,
+ * TRIM_TAIL: from only tail,
+ * TRIM_BOTH: from head and tail,
+ * TRIM_ALL: from all
+ * @param[out] len length of result string,
+ * if len == NULL then nothing returned.
* @return result string
*
* @par Usage:
diff -ur global-6.5-old/libutil/tab.c global-7.7-new/libutil/tab.c
--- global-6.5-old/libutil/tab.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/tab.c 2015-06-14 11:25:00.000000000 +0100
@@ -60,14 +60,14 @@
* Read file converting tabs into spaces.
*
* @param[out] buf
- * @param[in] size size of @a buf
+ * @param[in] size size of buf
* @param[in] ip input file
- * @param[out] dest_saved current column in @a buf
+ * @param[out] dest_saved current column in buf
* @param[out] spaces_saved left spaces
* @return size of data
*
* @attention
- * @a dest_saved and @a spaces_saved are control variables.
+ * dest_saved and spaces_saved are control variables.
* You must initialize them with 0 (zero) when the input file is opened.
*/
#define PUTSPACES \
@@ -118,7 +118,7 @@
/**
* detab_replacing: convert tabs into spaces and print with replacing.
*
- * @param[in] op @CODE{FILE *}
+ * @param[in] op FILE *
* @param[in] buf string including tabs
* @param[in] replace replacing function
*/
diff -ur global-6.5-old/libutil/test.c global-7.7-new/libutil/test.c
--- global-6.5-old/libutil/test.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/test.c 2015-06-15 18:07:36.000000000 +0100
@@ -44,7 +44,7 @@
#include "test.h"
/**
- * Decide whether or not the @a path is binary file.
+ * Decide whether or not the path is binary file.
*
* @param[in] path
* @return 0: is not binary, 1: is binary
@@ -76,17 +76,17 @@
/**
* test:
*
- * @param[in] flags file flags
- * @CODE{"f"} [ -f path ] is @a path a regular file (not a dir, link or pipe etc.)?
- * @CODE{"d"} [ -d path ] is @a path a dir?
- * @CODE{"r"} [ -r path ] can we read from @a path?
- * @CODE{"s"} [ -s path ] has @a path got a non-zero size?
- * @CODE{"w"} [ -w path ] can we write to @a path?
- * @CODE{"x"} [ -x path ] is @a path an executable file/program?
- * @CODE{"b"} [ -b path ] is @a path a binary file?
+ * @param[in] flags file flags
+ * "f" [ -f path ] is path a regular file (not a dir, link or pipe etc.)?
+ * "d" [ -d path ] is path a dir?
+ * "r" [ -r path ] can we read from path?
+ * "s" [ -s path ] has path got a non-zero size?
+ * "w" [ -w path ] can we write to path?
+ * "x" [ -x path ] is path an executable file/program?
+ * "b" [ -b path ] is path a binary file?
*
- * @param[in] path path to test,
- * if @VAR{NULL} then use the saved previous path, calls die() if is none.
+ * @param[in] path path to test,
+ * if NULL then use the saved previous path, calls die() if is none.
* @return 0: no, 1: ok
*
* You can specify more than one character. It assumed 'AND' test.
diff -ur global-6.5-old/libutil/token.c global-7.7-new/libutil/token.c
--- global-6.5-old/libutil/token.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/token.c 2015-06-17 18:42:35.000000000 +0100
@@ -39,13 +39,13 @@
*/
int lineno;
const char *sp, *cp, *lp;
-int crflag; /**< 1: return '\\n', 0: doesn't return */
-int cmode; /**< allow token which start with '\#' */
-int cppmode; /**< allow '\::' as a token */
-int ymode; /**< allow token which start with '\%' */
+int crflag; /* 1: return '\n', 0: doesn't return */
+int cmode; /* allow token which start with '#' */
+int cppmode; /* allow '::' as a token */
+int ymode; /* allow token which start with '%' */
char token[MAXTOKEN];
char curfile[MAXPATHLEN];
-int continued_line; /**< previous line ends with '\\\\' */
+int continued_line; /* previous line ends with '\' */
static char ptok[MAXTOKEN];
static int lasttok;
@@ -85,23 +85,23 @@
fclose(ip);
}
-/**
+/*
* nexttoken: get next token
*
- * @param[in] interested interested special character
- * if @VAR{NULL} then all character.
- * @param[in] reserved converter from token to token number
- * if this is specified, nexttoken() return
+ * @param[in] interested interested special character
+ * if NULL then all character.
+ * @param[in] reserved converter from token to token number
+ * if this is specified, nexttoken() return
* word number, else return symbol.
- * @return @VAR{EOF}(-1) end of file
- * c ==0 symbol (#SYMBOL; #token has the value.)
- * c \< 256 interested special character
- * c \> 1000 reserved word
+ * @return EOF(-1) end of file,
+ * c ==0 symbol (SYMBOL; token has the value.),
+ * c < 256 interested special character,
+ * c > 1000 reserved word
*
* @note nexttoken() doesn't return followings:
* - comment
- * - space (@CODE{' '}, @CODE{'\\t'}, @CODE{'\\f'}, @CODE{'\\v'}, @CODE{'\\r'})
- * - quoted string (@CODE{\"...\"}, @CODE{'.'})
+ * - space (' ', '\t', '\f', '\v', '\r')
+ * - quoted string ("...", '.')
* - number
*/
diff -ur global-6.5-old/libutil/usable.c global-7.7-new/libutil/usable.c
--- global-6.5-old/libutil/usable.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/usable.c 2015-06-15 18:13:21.000000000 +0100
@@ -49,8 +49,8 @@
* usable: check if command is executable or not.
*
* @param[in] command
- * @return ==NULL: not found.
- * !=NULL: absolute path of @a command.
+ * @return ==NULL: not found.
+ * !=NULL: absolute path of command.
*/
char *
usable(const char *command)
@@ -113,8 +113,8 @@
*
* @param[in] target_version
* @param[in] required_version
- * @return -1: error
- * 0: does not meet the requirement
+ * @return -1: error
+ * 0: does not meet the requirement
* 1: meets the requirement
*/
int
diff -ur global-6.5-old/libutil/varray.c global-7.7-new/libutil/varray.c
--- global-6.5-old/libutil/varray.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/varray.c 2015-06-15 18:16:53.000000000 +0100
@@ -33,7 +33,7 @@
Virtual array: usage and memory status
-_: allocated but not assigned.
+_: allocated but not assigned.
\@: assigned but the value is uncertainty.
@code
@@ -83,9 +83,9 @@
* varray_open: open virtual array.
*
* @param[in] size size of entry
- * @param[in] expand expand array size
- * if 0 (zero) is specified then use #DEFAULT_EXPAND.
- * @return vb #VARRAY structure
+ * @param[in] expand expand array size
+ * if 0 (zero) is specified then use DEFAULT_EXPAND.
+ * @return vb VARRAY structure
*/
VARRAY *
varray_open(int size, int expand)
@@ -105,14 +105,14 @@
/**
* varray_assign: assign varray entry.
*
- * @param[in] vb #VARRAY structure
+ * @param[in] vb VARRAY structure
* @param[in] index index
* @param[in] force if entry not found, create it.
* @return pointer of the entry
*
* If specified entry is found then it is returned, else it is allocated
* and returned.
- * This procedure @EMPH{doesn't} operate the contents of the array.
+ * This procedure doesn't operate the contents of the array.
*/
void *
varray_assign(VARRAY *vb, int index, int force)
@@ -153,10 +153,10 @@
/**
* varray_append: append varray entry.
*
- * @param[in] vb #VARRAY structure
+ * @param[in] vb VARRAY structure
* @return pointer of the entry
*
- * This procedure @EMPH{doesn't} operate the contents of the array.
+ * This procedure doesn't operate the contents of the array.
*/
void *
varray_append(VARRAY *vb)
@@ -166,7 +166,7 @@
/**
* varray_reset: reset varray array.
*
- * @param[in] vb #VARRAY structure
+ * @param[in] vb VARRAY structure
*/
void
varray_reset(VARRAY *vb)
@@ -176,7 +176,7 @@
/**
* varray_close: close varray array.
*
- * @param[in] vb #VARRAY structure
+ * @param[in] vb VARRAY structure
*/
void
varray_close(VARRAY *vb)
diff -ur global-6.5-old/libutil/xargs.c global-7.7-new/libutil/xargs.c
--- global-6.5-old/libutil/xargs.c 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/xargs.c 2015-06-17 18:48:23.000000000 +0100
@@ -49,7 +49,7 @@
static XARGS *xargs_open_generic(const char *, int);
/**
- @file
+ * @file
*
* @details
* usage: a piece of code to achieve the following command line.
@@ -72,8 +72,8 @@
* exec_line_limit: upper limit of bytes of exec line.
*
* @param[in] length command line length
- * @return 0: unknown or cannot afford long line.
- * \> 0: upper limit of exec line
+ * @return 0: unknown or cannot afford long line.
+ * > 0: upper limit of exec line
*/
static int
exec_line_limit(int length)
@@ -137,12 +137,12 @@
}
/**
- * Specified limitation by user. (e.g. @CODE{gtags --max-args})
+ * Specified limitation by user. (e.g. gtags --max-args)
*/
#define LT_MAX ((xp->max_args == 0 || count < xp->max_args))
/**
- * Common processing for each @NAME{XARGS_XXXX} type.
+ * Common processing for each XARGS_XXXX type.
*/
#ifdef _WIN32
#define QUOTE '"'
@@ -180,12 +180,12 @@
* execute_command
*
* @param[in] xp xargs structure
- * @return !=NULL: file pointer
+ * @return !=NULL: file pointer
* ==NULL: end of argument
*
- * This function constructs command line from the following,
- * @STRONG{command}: @CODE{xp-\>command}
- * @STRONG{argument}: each argument provider
+ * This function constructs command line from the following,
+ * command: xp->command
+ * argument: each argument provider
* execute it on a pipe line, and return the file pointer.
*/
static FILE *
@@ -275,7 +275,7 @@
* xargs_open_generic: allocate generic part of xargs structure.
*
* @param[in] command command line except for the arguments.
- * @param[in] max_args 0: no limit, \>0: max argument
+ * @param[in] max_args 0: no limit, >0: max argument
* @return xargs structure
*/
static XARGS *
@@ -319,16 +319,16 @@
return xp;
}
-/**
+/*
* xargs_open_with_file: open xargs stream using file
*
* @param[in] command command skeleton.
- * @param[in] max_args 0: no limit, \>0: max argument
+ * @param[in] max_args 0: no limit, >0: max argument
* @param[in] ip file pointer
* @return xargs structure
*
- * The @CODE{'\%s'} in the command skeleton is replaced with given arguments.
- * If @CODE{'\%s'} doesn't exist, the arguments is appended to the tail of the
+ * The '%s' in the command skeleton is replaced with given arguments.
+ * If '%s' doesn't exist, the arguments is appended to the tail of the
* skeleton.
*/
XARGS *
@@ -342,17 +342,17 @@
xp->fptr = 0;
return xp;
}
-/**
- * xargs_open_with_argv: open xargs stream using @a argv
+/*
+ * xargs_open_with_argv: open xargs stream using argv
*
* @param[in] command command skeleton.
- * @param[in] max_args 0: no limit, \>0: max argument
+ * @param[in] max_args 0: no limit, >0: max argument
* @param[in] argc argument number
* @param[in] argv argument array
* @return xargs structure
*
- * The @CODE{'\%s'} in the command skeleton is replaced with given arguments.
- * If @CODE{'\%s'} doesn't exist, the arguments is appended to the tail of the
+ * The '%s' in the command skeleton is replaced with given arguments.
+ * If '%s' doesn't exist, the arguments is appended to the tail of the
* skeleton.
*/
XARGS *
@@ -365,16 +365,16 @@
xp->argv = argv;
return xp;
}
-/**
+/*
* xargs_open_with_strbuf: open xargs stream using string buffer
*
* @param[in] command command skeleton.
- * @param[in] max_args 0: no limit, \>0: max argument
+ * @param[in] max_args 0: no limit, >0: max argument
* @param[in] sb string buffer
* @return xargs structure
*
- * The @CODE{'\%s'} in the command skeleton is replaced with given arguments.
- * If @CODE{'\%s'} doesn't exist, the arguments is appended to the tail of the
+ * The '%s' in the command skeleton is replaced with given arguments.
+ * If '%s' doesn't exist, the arguments is appended to the tail of the
* skeleton.
*/
XARGS *
@@ -387,15 +387,15 @@
xp->endp = xp->curp + strbuf_getlen(sb);
return xp;
}
-/**
- * xargs_open_with_find: open xargs stream using @NAME{find()}.
+/*
+ * xargs_open_with_find: open xargs stream using find().
*
* @param[in] command command skeleton.
- * @param[in] max_args 0: no limit, \>0: max argument
+ * @param[in] max_args 0: no limit, >0: max argument
* @return xargs structure
*
- * The @CODE{'\%s'} in the command skeleton is replaced with given arguments.
- * If @CODE{'\%s'} doesn't exist, the arguments is appended to the tail of the
+ * The '%s' in the command skeleton is replaced with given arguments.
+ * If '%s' doesn't exist, the arguments is appended to the tail of the
* skeleton.
*/
XARGS *
diff -ur global-6.5-old/libutil/xargs.h global-7.7-new/libutil/xargs.h
--- global-6.5-old/libutil/xargs.h 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/libutil/xargs.h 2015-06-15 18:22:45.000000000 +0100
@@ -24,25 +24,21 @@
#include "strbuf.h"
-/**
- * @name Types
+/*
+ * Types
*/
-/** @{ */
#define XARGS_FILE 1
#define XARGS_ARGV 2
#define XARGS_STRBUF 3
#define XARGS_FIND 4
-/** @} */
-/**
- * @name Options
+/*
+ * Options
*/
-/** @{ */
#define XA_IGNORE_ERROR 1
#define XA_SKIP_NOTSOURCE 2
#define XA_PUT_GPATH 4
#define XA_TRIM_LINE 8
-/** @} */
typedef struct {
/*
@@ -54,46 +50,38 @@
int end_of_arg;
int unread;
int seqno; /**< sequencial number */
- int type; /**< @NAME{XARGS_XXX} Types */
- /**
- * @name options
+ int type; /**< XARGS_XXX Types */
+ /*
+ * options
*
- * These variables are set to directly by calling procedures.
+ * These variables are set to directly by calling procedures.
* This might have to be reviewed.
*/
- /** @{ */
int ignore_error;
- int max_args; /**< 0: no limit, \>0: limit */
+ int max_args; /**< 0: no limit, >0: limit */
int put_gpath;
int trim_line;
int skip_assembly;
void (*verbose)(char *, int, int);
- /** @} */
- /**
- * @name XARGS_FILE
+ /*
+ * XARGS_FILE
*/
- /** @{ */
FILE *ip;
long fptr;
STRBUF *path;
- /** @} */
- /**
- * @name XARGS_ARGV
+ /*
+ * XARGS_ARGV
*/
- /** @{ */
int argc;
char *const *argv;
- /** @} */
- /**
- * @name XARGS_STRBUF
+ /*
+ * XARGS_STRBUF
*/
- /** @{ */
char *curp;
char *endp;
- /** @} */
/*
* XARGS_FIND
diff -ur global-6.5-old/mainpage.dox global-7.7-new/mainpage.dox
--- global-6.5-old/mainpage.dox 2015-06-10 02:45:10.000000000 +0100
+++ global-7.7-new/mainpage.dox 2015-06-14 16:29:12.000000000 +0100
@@ -1,17 +1,16 @@
/**
address@hidden GNU GLOBAL source code tag system
address@hidden
address@hidden GNU GLOBAL source code tagging system
address@hidden
___________________________________
| | | | | _ | | |
-| |___| | | | | _| | | | GNU GLOBAL source code tag system
+| |___| | | | | _| | | | GNU GLOBAL source code tagging system
| | | | | | | | | |
| ~~ | ~~| | ~ | | | ~~| for all hackers.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
address@hidden
address@hidden
address@hidden @NAME{GLOBAL} is a source code tag system that works the same way across diverse
-environments. It supports @NAME{C}, @NAME{C++}, @NAME{Yacc}, @NAME{Java}, @NAME{PHP4} and
address@hidden source code.
+GNU GLOBAL is a source code tagging system that works the same way across diverse
+environments. It supports C, C++, Yacc, Java, PHP4 and assembly source code.
@section s1 The main() files
@@ -25,19 +24,19 @@
@ref htags.c "htags.c -- generate hypertext (XHTML or HTML) pages from a set of source files."
- Click on the @STRONG{Files} button above, to see all the source files documented by @NAME{Doxygen}.
+ Click on the Files button above, to see all the source files documented by Doxygen.
@section s2 Documentation
- Please see @FILE{doc/global.texi} (texinfo format) to know how to use @NAME{GLOBAL}.
- You can see it even on @NAME{GLOBAL}'s web site:
+ Please see "doc/global.texi" (texinfo format) to know how to use GLOBAL.
+ You can see it even on GLOBAL's web site:
- @FILE{http://www.gnu.org/software/global/globaldoc_toc.html}
- @FILE{http://www.gnu.org/software/global/manual/}
+ "http://www.gnu.org/software/global/globaldoc_toc.html"
+ "http://www.gnu.org/software/global/manual/"
@section s3 Latest information
- You can see the latest information on @NAME{GLOBAL}'s web site.
+ You can see the latest information on GLOBAL's web site.
- @FILE{http://www.gnu.org/software/global/whatsnew.html}
+ "http://www.gnu.org/software/global/whatsnew.html"
*/