From: handa Date: Fri, 16 Jan 2009 05:54:22 +0000 (+0000) Subject: *** empty log message *** X-Git-Tag: XML-base~1 X-Git-Url: http://git.chise.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=eec81e9290cc6e143f551aaf60d352a89a3c7f18;p=m17n%2Fm17n-docs.git *** empty log message *** --- diff --git a/Makefile.am b/Makefile.am index f8841ad..bdc7b6a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -147,11 +147,10 @@ doxyfile: Makefile -e '/^ENABLED_SECTIONS / s/=.*/= %ENABLED_SECTIONS%/' \ -e '/^SHOW_USED_FILES / s/=.*/= NO/' \ -e '/^INPUT / s/=.*/= %INPUT%/' \ - -e '/^INPUT_ENCODING / s/=.*/= %INPUT_ENCODING%/' \ -e '/^FILE_PATTERNS / s/=.*/= *.c *.txt/' \ - -e '/^EXCLUDE_PATTERNS / s/=.*/= link*.c/' \ + -e '/^EXCLUDE_PATTERNS / s/=.*/= link*.c font-ft.c/' \ -e '/^EXAMPLE_PATH / s/=.*/= data-%USR_JA_DEV%/' \ - -e '/^IMAGE_PATH / s/=.*/= image/' \ + -e '/^IMAGE_PATH / s/=.*/= images/' \ -e '/^INPUT_FILTER / s/=.*/= utils\/%USR_JA_DEV%_filter.sh/' \ -e '/^VERBATIM_HEADERS / s/=.*/= NO/' \ -e '/^ALPHABETICAL_INDEX / s/=.*/= YES/' \ @@ -159,12 +158,13 @@ doxyfile: Makefile -e '/^GENERATE_HTML / s/=.*/= %GENERATE_HTML%/' \ -e '/^HTML_HEADER / s/=.*/= header.%USR_JA_DEV%.html/' \ -e '/^HTML_FOOTER / s/=.*/= footer.%USR_JA_DEV%.html/' \ - -e '/^DISABLE_INDEX / s/=.*/= NO/' \ + -e '/^DISABLE_INDEX / s/=.*/= YES/' \ -e '/^ENUM_VALUES_PER_LINE / s/=.*/= 1/' \ -e '/^GENERATE_LATEX / s/=.*/= %GENERATE_LATEX%/' \ -e '/^EXTRA_PACKAGES / s/=.*/= m17n-lib times/' \ -e '/^PDF_HYPERLINKS / s/=.*/= NO/' \ -e '/^USE_PDFLATEX / s/=.*/= NO/' \ + -e '/^LATEX_HIDE_INDICES / s/=.*/= YES/' \ -e '/^GENERATE_MAN / s/=.*/= %GENERATE_MAN%/' \ -e '/^MAN_EXTENSION / s/=.*/= %MAN_EXTENSION%/' \ -e '/^PREDEFINED / s/=.*/= FOR_DOXYGEN/' \ @@ -221,7 +221,6 @@ doxyfile-latex.dev: doxyfile-latex doxyfile-latex.ja: doxyfile-latex sed -e 's|%PROJECT_NAME%|${PROJECT_NAME_JA}|' \ - -e 's|INPUT_ENCODING.*= UTF-8|INPUT_ENCODING = EUC-JP|' \ -e 's/%USR_JA_DEV%/ja/g' \ -e 's/%OUTPUT_LANGUAGE%/Japanese/' \ < $< >$@ @@ -339,10 +338,12 @@ man/man1/%: usr/man/man1/% sample/man3/SampleGroup.3 utils/mkman.rb rm -rf doxywork man/man1/* ruby utils/mkman.rb 1 usr/man/man1 man/man1 -man/man3/%: usr/man/man3/% sample/man3/SampleGroup.3 utils/mkman.rb +man/man3/%: usr/man/man3/% sample/man3/SampleGroup.3 utils/mkman.rb \ + utils/reform-man3.sh utils/reform-man3.awk $(mkinstalldirs) man/man3 rm -rf doxywork man/man3/* ruby utils/mkman.rb 3m17n usr/man/man3m17n man/man3 + utils/reform-man3.sh man/man3 man/man5/%: usr/man/man5/% sample/man3/SampleGroup.3 utils/mkman.rb $(mkinstalldirs) man/man5 @@ -354,7 +355,7 @@ man/ja/man1/%: ja/man/man1/% sample/man3/SampleGroup.3 utils/mkman.rb rm -rf doxywork man/ja/man1/* ruby utils/mkman.rb 1 ja/man/man1 man/ja/man1 -man/ja/man3/%: ja/man/man3/% sample/man3/SampleGroup.3 utils/mkman.rb +man/ja/man3/%: ja/man/man3/% sample/man3/SampleGroup.3 utils/mkman.rb $(mkinstalldirs) man/ja/man3 rm -rf doxywork man/ja/man3/* ruby utils/mkman.rb 3m17n ja/man/man3 man/ja/man3 diff --git a/doxyfile b/doxyfile index 8c47acd..92fee2d 100644 --- a/doxyfile +++ b/doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.5.2 +# Doxyfile 1.5.5 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -14,11 +14,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file that -# follow. The default is UTF-8 which is also the encoding used for all text before -# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into -# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of -# possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 @@ -54,10 +54,11 @@ CREATE_SUBDIRS = NO # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. OUTPUT_LANGUAGE = %OUTPUT_LANGUAGE% @@ -66,14 +67,14 @@ OUTPUT_LANGUAGE = %OUTPUT_LANGUAGE% # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. -BRIEF_MEMBER_DESC = yes +BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. -REPEAT_BRIEF = no +REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string @@ -91,7 +92,7 @@ ABBREVIATE_BRIEF = # Doxygen will generate a detailed section even if there is only a brief # description. -ALWAYS_DETAILED_SEC = no +ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those @@ -104,7 +105,7 @@ INLINE_INHERITED_MEMB = NO # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = NO +FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is @@ -133,11 +134,19 @@ SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an -# explicit @brief command for a brief description. +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = NO +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. @@ -184,17 +193,29 @@ ALIASES = # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. -OPTIMIZE_OUTPUT_FOR_C = yes +OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration @@ -207,12 +228,18 @@ BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. -DISTRIBUTE_GROUP_DOC = yes +DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a @@ -222,6 +249,16 @@ DISTRIBUTE_GROUP_DOC = yes SUBGROUPING = YES +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -231,17 +268,17 @@ SUBGROUPING = YES # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = yes +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. -EXTRACT_PRIVATE = no +EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = no +EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. @@ -256,13 +293,21 @@ EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. -HIDE_UNDOC_MEMBERS = yes +HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. @@ -290,7 +335,7 @@ HIDE_IN_BODY_DOCS = NO # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. -INTERNAL_DOCS = no +INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also @@ -310,7 +355,7 @@ HIDE_SCOPE_NAMES = NO # will put a list of the files that are included by a file in the documentation # of that file. -SHOW_INCLUDE_FILES = no +SHOW_INCLUDE_FILES = NO # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. @@ -322,7 +367,7 @@ INLINE_INFO = YES # alphabetically by member name. If set to NO the members will appear in # declaration order. -SORT_MEMBER_DOCS = no +SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically @@ -331,6 +376,12 @@ SORT_MEMBER_DOCS = no SORT_BRIEF_DOCS = NO +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, @@ -384,7 +435,7 @@ MAX_INITIALIZER_LINES = 30 # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. -SHOW_USED_FILES = no +SHOW_USED_FILES = NO # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy @@ -393,8 +444,8 @@ SHOW_USED_FILES = no SHOW_DIRECTORIES = NO # The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output @@ -445,13 +496,13 @@ WARN_NO_PARAMDOC = NO # $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) -WARN_FORMAT = "$text in $file line $line" +WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = warning +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files @@ -464,10 +515,11 @@ WARN_LOGFILE = warning INPUT = %INPUT% -# This tag can be used to specify the character encoding of the source files that -# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default -# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. -# See http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. INPUT_ENCODING = UTF-8 @@ -476,10 +528,9 @@ INPUT_ENCODING = UTF-8 # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.c \ - *.txt +FILE_PATTERNS = *.c *.txt # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -505,14 +556,13 @@ EXCLUDE_SYMLINKS = NO # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = font-flt.c \ - font-ft.c \ - link*.c +EXCLUDE_PATTERNS = link*.c font-ft.c # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the output. -# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, -# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = @@ -576,12 +626,12 @@ FILTER_SOURCE_FILES = NO # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. -SOURCE_BROWSER = no +SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. -INLINE_SOURCES = no +INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code @@ -593,13 +643,13 @@ STRIP_CODE_COMMENTS = YES # then for each documented function all documented # functions referencing it will be listed. -REFERENCED_BY_RELATION = YES +REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES (the default) # then for each documented function all documented entities # called/used by that function will be listed. -REFERENCES_RELATION = YES +REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from @@ -620,7 +670,7 @@ USE_HTAGS = NO # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. -VERBATIM_HEADERS = no +VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index @@ -630,7 +680,7 @@ VERBATIM_HEADERS = no # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. -ALPHABETICAL_INDEX = yes +ALPHABETICAL_INDEX = YES # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns @@ -643,8 +693,7 @@ COLS_IN_ALPHA_INDEX = 5 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = m \ - M +IGNORE_PREFIX = m M #--------------------------------------------------------------------------- # configuration options related to the HTML output @@ -659,7 +708,7 @@ GENERATE_HTML = %GENERATE_HTML% # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. -HTML_OUTPUT = +HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank @@ -692,15 +741,48 @@ HTML_STYLESHEET = # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. -HTML_ALIGN_MEMBERS = yes +HTML_ALIGN_MEMBERS = YES # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be @@ -730,13 +812,13 @@ BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. -TOC_EXPAND = yes +TOC_EXPAND = NO # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. -DISABLE_INDEX = yes +DISABLE_INDEX = YES # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. @@ -750,13 +832,13 @@ ENUM_VALUES_PER_LINE = 1 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. -GENERATE_TREEVIEW = no +GENERATE_TREEVIEW = NO # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. -TREEVIEW_WIDTH = 220 +TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output @@ -771,7 +853,7 @@ GENERATE_LATEX = %GENERATE_LATEX% # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. -LATEX_OUTPUT = +LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. @@ -788,7 +870,7 @@ MAKEINDEX_CMD_NAME = makeindex # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. -COMPACT_LATEX = no +COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and @@ -799,8 +881,7 @@ PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = m17n-lib \ - times +EXTRA_PACKAGES = m17n-lib times # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until @@ -814,7 +895,7 @@ LATEX_HEADER = # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. -PDF_HYPERLINKS = no +PDF_HYPERLINKS = NO # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a @@ -833,7 +914,7 @@ LATEX_BATCHMODE = NO # include the index chapters (such as File Index, Compound Index, etc.) # in the output. -LATEX_HIDE_INDICES = NO +LATEX_HIDE_INDICES = YES #--------------------------------------------------------------------------- # configuration options related to the RTF output @@ -843,13 +924,13 @@ LATEX_HIDE_INDICES = NO # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. -GENERATE_RTF = no +GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. -RTF_OUTPUT = +RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to @@ -890,7 +971,7 @@ GENERATE_MAN = %GENERATE_MAN% # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. -MAN_OUTPUT = +MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) @@ -913,7 +994,7 @@ MAN_LINKS = NO # generate an XML file that captures the structure of # the code including all documentation. -GENERATE_XML = no +GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be @@ -1006,7 +1087,7 @@ MACRO_EXPANSION = NO # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. -EXPAND_ONLY_PREDEF = YES +EXPAND_ONLY_PREDEF = NO # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. @@ -1092,7 +1173,7 @@ EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). -PERL_PATH = +PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool @@ -1108,10 +1189,11 @@ PERL_PATH = CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to -# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to -# specify the directory where the mscgen tool resides. If left empty the tool is assumed to -# be found in the default search path. +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. MSCGEN_PATH = @@ -1172,26 +1254,26 @@ INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a caller dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. -GRAPHICAL_HIERARCHY = yes +GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories @@ -1220,18 +1302,30 @@ DOTFILE_DIRS = # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen will always -# show the root nodes and its direct children regardless of this setting. +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). -DOT_TRANSPARENT = NO +DOT_TRANSPARENT = YES # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This @@ -1259,4 +1353,4 @@ DOT_CLEANUP = YES # The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. -SEARCHENGINE = no +SEARCHENGINE = NO diff --git a/utils/dbdata.sh b/utils/dbdata.sh index 2978cf9..f2095de 100755 --- a/utils/dbdata.sh +++ b/utils/dbdata.sh @@ -19,7 +19,7 @@ while shift 1; do HEADER="
  • $FILE (extra-name:$EXTRA, only for inclusion)" HEADER2="" else - title=`sed -n -e '/^(title/s/(title \("[^"]*"\).*$/\1/p' $FILE` +# title=`sed -n -e '/^(title/s/(title \("[^"]*"\).*$/\1/p' $FILE` file=`basename $FILE` base=`basename $file .mim` dir=`dirname $FILE` @@ -29,9 +29,9 @@ while shift 1; do [ -f "images/icon-$base.png" ] || cp "$icon" "images/icon-$base.png" fi HEADER="
  • $base (language:$LNG name:$NAME @htmlonly" - if test -n "$title"; then - HEADER="$HEADER title:$title" - fi +# if test -n "$title"; then +# HEADER="$HEADER title:$title" +# fi HEADER2="" HEADER3="@endhtmlonly" HEADER4=")" @@ -41,7 +41,8 @@ while shift 1; do echo "$HEADER2"; echo "$HEADER3"; echo "$HEADER4" fi echo - sed -n -e '/^;;;/ p' $FILE | sed -e '/^[^;]/ s/$/
    /' -e '/^;;;/ s/^;;; *//' | sed -e 's,^||,,' -e 's,||$,,' -e 's,|,,g') + sed -n -e '/^;;;/ p' $FILE | sed -e '/^[^;]/ s/$/
    /' -e '/^;;;/ s/^;;; *//' | sed -e 's,^||,,' -e 's,||$,,' -e 's,|,,g' + ) else M17NDIR=/usr/share/m17n $IMDOC $FILE "$IM" fi diff --git a/utils/imdoc.c b/utils/imdoc.c index 8854093..644f250 100644 --- a/utils/imdoc.c +++ b/utils/imdoc.c @@ -17,6 +17,8 @@ invalid_file (char *filename) exit (1); } +#define INHIBIT_TITLE + int main (int argc, char **argv) { @@ -103,10 +105,16 @@ main (int argc, char **argv) { MText *title = mplist_value (plist); +#ifndef INHIBIT_TITLE printf ("@htmlonly\n title:\""); +#else + printf ("@htmlonly\n"); +#endif plist = mplist_next (plist); +#ifndef INHIBIT_TITLE mconv_encode_stream (Mutf8, title, stdout); printf ("\""); +#endif if (mplist_key (plist) != Mnil) { MText *icon = mplist_value (plist); diff --git a/utils/ja_filter.rb b/utils/ja_filter.rb index d335c4a..e2f7ac1 100755 --- a/utils/ja_filter.rb +++ b/utils/ja_filter.rb @@ -14,10 +14,10 @@ def commentblock(buf) while gets - gsub!("@seealso", "@par 参照:") - gsub!("@errors", "@par エラー:") - gsub!("@returns", "@par 戻り値:") - gsub!("@return", "@par 戻り値:") + gsub!("@seealso", "@par »²¾È:") + gsub!("@errors", "@par ¥¨¥é¡¼:") + gsub!("@returns", "@par Ìá¤êÃÍ:") + gsub!("@return", "@par Ìá¤êÃÍ:") #let doxygen find functions gsub!(/[a-zA-Z_]\s\(\)/) {|m| m.delete!(" ")} #make variables in function descriptions shown in bold @@ -85,7 +85,7 @@ while gets when /EXAMPLE_CODE/ #start example code lines - buf.push($_.gsub!(/#if EXAMPLE_CODE/, "\n \n @par 例： \n @code")) + buf.push($_.gsub!(/#if EXAMPLE_CODE/, "\n \n @par Î㡧 \n @code")) example = 1 when /\*\// @@ -110,5 +110,5 @@ end commentblock(buf) # Local Variables: -# coding: utf-8 +# coding: euc-jp # End: diff --git a/utils/ja_filter.sh b/utils/ja_filter.sh index 544d0ee..9cddce5 100755 --- a/utils/ja_filter.sh +++ b/utils/ja_filter.sh @@ -1,7 +1,3 @@ #!/bin/sh -case $1 in -*.[ch]) iconv -f EUC-JP -t UTF-8 < $1 | utils/ja_filter.rb;; -*.txt) iconv -f EUC-JP -t UTF-8 < $1 | utils/ja_filter.rb;; -*) utils/ja_filter.rb $1;; -esac +utils/ja_filter.rb $1 | iconv -f EUC-JP -t UTF-8 diff --git a/utils/latex.sh b/utils/latex.sh index e854fad..5236482 100755 --- a/utils/latex.sh +++ b/utils/latex.sh @@ -15,12 +15,11 @@ if [ $USR_JA_DEV = "ja" ] ; then PATH=/usr/local/teTeX/bin:$PATH fi SOURCE=m17n-lib-ja + echo '\appendix' > app.tex + sed -n -e '/コンパイル/,/GFDL/ p' < refman.tex >> app.tex sed -e '/documentclass/ s/a4paper/a4paper,twoside/' \ - -e '/モジュール索引/,/modules/ d' \ - -e '/ファイル索引}/,/files/ d' \ - -e '/ファイル}/,/textprop_8c/ d' \ - -e '/m17n ライブラリ Directory Documentation/,/dir_000001/ d' \ - -e 's/m17n ライブラリ ページ/Appendix/' \ + -e '/コンパイル/,/GFDL/ d' \ + -e '/structMInputXIMArgIM/ r app.tex' \ < refman.tex > ${SOURCE}.tex elif [ $USR_JA_DEV = "dev" ] ; then SOURCE=m17n-lib-dev @@ -32,11 +31,11 @@ elif [ $USR_JA_DEV = "dev" ] ; then < refman.tex > ${SOURCE}.tex else SOURCE=m17n-lib + echo '\appendix' > app.tex + sed -n -e '/Print compile/,/GFDL/ p' < refman.tex >> app.tex sed -e '/documentclass/ s/a4paper/a4paper,twoside/' \ - -e '/Module Index/,/modules/ d' \ - -e '/File Documentation/,/textprop_8c/ d' \ - -e '/The m17n Library Directory Documentation/,/dir_000001/ d' \ - -e 's/The m17n Library Page Documentation/Appendix/' \ + -e '/Print compile/,/GFDL/ d' \ + -e '/structMInputXIMArgIM/ r app.tex' \ < refman.tex > ${SOURCE}.tex fi ${LATEX} ${SOURCE}.tex