Gauche:Undocumented
yamasushi(2013/03/31 08:17:24 UTC)ドキュメントがないモジュールを調べて見ました。機械的にとってきたので、要検証ではあります。(ドキュメントの有無はinfoの索引で調べました。)
- yamasushi(2013/04/23 22:04:21 UTC) チェックにつかっているツール→Gauche:ドキュメントがあるかどうか調べる
予備調査
特殊なケース
- exportがないモジュール
- gauche.cgen
- gauche.experimental.app
- gauche.experimental.ref
- gauche.vm.insn
- rfc.sha1
- srfi-29
- srfi-4
- srfi-9
- www.cgi-test
- デフォルトモジュールのシンボルしかexportしていないが、デフォルトと異なるオブジェクトをもっているモジュール
- util.list
- cond-list
- assv-set!
- assq-set!
- util.list
- gauche.vm.debugger
- debug-print
- gauche.condutil
- condition
- gauche.defvalues
- set!-values
- srfi-5
- let
- srfi-7
- program
- srfi-29.format
- format
- srfi-55
- require-extension
デフォルトで読み込むモジュール
- exportの一部がdefaultモジュールに取り込まれているもの
- compat.stk
- gauche.condutil ; condutil.scm - condition primitives. autoloaded.
- gauche.defvalues ; gauche/defvalues.scm - define-values and set!-values, to be autoloaded
- gauche.modutil ; module related utility functions. to be autoloaded.
- gauche.regexp ; regexp.scm - auxiliary macros and procedures for regexp. autoloaded.
- gauche.uvector
- gauche.vm.debugger
- gauche.vm.profiler
- srfi-1
- srfi-14
- srfi-60
- util.list ; util/list.scm - more list library (Gauche 0.9.3でコアに)
- exportのすべてがdefaultモジュールに取り込まれているもの
- compat.norational
- gauche.fileutil ; file related utility functions. to be autoloaded.
- gauche.hashutil ; auxiliary hashtable utilities. to be autoloaded.
- gauche.interpolate ; interpolate.scm - string interpolation; to be autoloaded
- gauche.libutil ; library utilities - to be autoloaded.
- gauche.portutil ; port related utility functions. to be autoloaded.
- gauche.procedure ; procedure.scm - auxiliary procedure utilities. to be autoloaded.
- gauche.sortutil ; Richard A. O'Keefe (based on Prolog code by D.H.D.Warren).
- gauche.stringutil ; auxiliary string utilities. to be autoloaded.
- gauche.treeutil ; auxiliary treemap utilities. to be autoloaded.
- srfi-0
- srfi-26
- srfi-31
モジュール
- 索引のないモジュール
- gauche.macroutil ; Handy macro expander
GaucheSource:lib/gauche/macroutil.scm - util.tree ; tree.scm - walk tree
GaucheSource:lib/util/tree.scm
- gauche.macroutil ; Handy macro expander
- experimental
- gauche.experimental.app ; ;; This is for compatibility - while compiling 0.9.3 we need to use 0.9.2,
- gauche.experimental.lamb ; gauche.experimenta.lamb - shorthand notation of lambda
- gauche.experimental.ref ;; '~' is integrated into the core (see lib/gauche/procedure.scm)
- compatibility interface
- compat.jfilter ; compat.jfilter - jfilter compatibility interface
- compat.stk ; port.stk - stk compatibility interface
- binary.ftype ; binary.ftype - foreign types and foreign objects
- data.random ; data.random - Random data genarators
- dbd.null ; dbd.null - A database driver that does (almost) nothing
- gauche.serializer ; serializer.scm - generic serializer framework
- rfc.tls
- sxml.adaptor ; Adapt SSAX to Gauche
- www.cgi-test ; www.cgi-test - backward compatibility file
- gauche.test
- gauche.test.generative ;; gauche.test.generative - Generative tests
- gauche.vm
- gauche.vm.debugger ; Debugging aids
- gauche.vm.insn ; Generated from vminsn.scm. DO NOT EDIT
- gauche.vm.insn-core ; <vm-insn-info> definition
- gauche.vm.profiler ; Profiler - profiler interface
- gauche.package
- gauche.package ; gauche.package - package management
- gauche.package.build ; gauche.package.build - build a package
- gauche.package.compile ; gauche.package.compile - compile extensions
- gauche.package.fetch ; gauche.package.fetch - fetch a package
- gauche.package.util ; gauche.package.util - internal utilities used in package manager
- Gauche:parser.pegの使い方 Tag:parser.peg
- parser.peg
- Tag:text.info Tag:gauche.interactive.info
- text.info ; info.scm - parse info file
- gauche.interactive.info ; interactive/info.scm - online helper
- gauche.cgen
- gauche.cgen.cise ;; gauche.cgen.cise - C in S expression Tag:CiSE
- gauche.cgen.literal ; gauche.cgen.literal - static literal data
- gauche.cgen.precomp ; gauche.cgen.precomp - Precompile Scheme into C data
- gauche.cgen.tmodule ; gauche.cgen.tmodule - Transient module
- gauche.cgen.type ;; gauche.cgen.type - type management
- gauche.cgen.unit ;; gauche.cgen.unit - cgen-unit
- Gauche:MOP:InstancePool Scheme:MOP:InstancePool Tag:gauche.mop.instance-pool
- gauche.mop.instance-pool ; instance-pool.scm - instance pool metaclass
- SXSLT(sxml.tree-transの使い方) Tag:sxml.tree-trans
- sxml.to-html ; sxml.to-html - SXML->HTML translator Oleg Kiselyov's SXML->HTML.scm.
- sxml.tree-trans ; sxml.tree-trans - SXML utility Oleg Kiselyov's SXML-tree-trans.scm, v 1.5.
- sxml.to-html ; sxml.to-html - SXML->HTML translator Oleg Kiselyov's SXML->HTML.scm.
クラス
- モジュールには索引があるが、クラスに索引がない( <*-error>)
- dbi
- <dbi-error>
- <dbi-nonexistent-driver-error>
- <dbi-parameter-error>
- <dbi-unsupported-error>
- gauche.parseopt
- <parseopt-error>
- rfc.822
- <rfc822-parse-error>
- rfc.json
- <json-construct-error>
- <json-parse-error>
- rfc.zlib
- <zlib-data-error>
- <zlib-error>
- <zlib-memory-error>
- <zlib-need-dict-error>
- <zlib-stream-error>
- <zlib-version-error>
- text.sql
- <sql-parse-error>
- www.cgi
- <cgi-content-type-error>
- <cgi-error>
- <cgi-request-method-error>
- <cgi-request-size-error>
- dbi
- モジュールには索引があるが、クラスに索引がない( <*-meta>)
- gauche
- <%box-meta>
- <abandoned-mutex-exception-meta>
- <autoload-meta>
- <boolean-meta>
- <char-meta>
- <char-set-meta>
- <complex-meta>
- <f16vector-meta>
- <f32vector-meta>
- <f64vector-meta>
- <gloc-meta>
- <hash-table-meta>
- <integer-meta>
- <join-timeout-exception-meta>
- <keyword-meta>
- <lazy-pair-meta>
- <list-meta>
- <macro-meta>
- <module-meta>
- <null-meta>
- <number-meta>
- <pair-meta>
- <promise-meta>
- <rational-meta>
- <real-meta>
- <regexp-meta>
- <regmatch-meta>
- <s16vector-meta>
- <s32vector-meta>
- <s64vector-meta>
- <s8vector-meta>
- <string-meta>
- <string-pointer-meta>
- <symbol-meta>
- <syntax-meta>
- <syntax-pattern-meta>
- <syntax-rules-meta>
- <terminated-thread-exception-meta>
- <thread-exception-meta>
- <thread-meta>
- <tree-map-meta>
- <u16vector-meta>
- <u32vector-meta>
- <u64vector-meta>
- <u8vector-meta>
- <uncaught-exception-meta>
- <uvector-meta>
- <vector-meta>
- <weak-hash-table-meta>
- <weak-vector-meta>
- gauche.array
- <array-meta>
- gauche.record
- <pseudo-record-meta>
- <record-meta>
- gauche.uvector
- <f16vector-meta>
- <f32vector-meta>
- <f64vector-meta>
- <s16vector-meta>
- <s32vector-meta>
- <s64vector-meta>
- <s8vector-meta>
- <u16vector-meta>
- <u32vector-meta>
- <u64vector-meta>
- <u8vector-meta>
- <uvector-meta>
- gauche
- モジュールには索引があるが、クラスに索引がない(その他)
- control.job
- job
- <thread-pool-shut-down>
- dbi
- <dbi-result-set>
- file.util
- <lock-file-failure>
- gauche
- <accessor-method>
- <arity-at-least>
- <autoload>
- <coding-aware-port>
- <collection>
- <compiled-code>
- <dictionary>
- <eof-object>
- <foreign-pointer>
- <generic>
- <gloc>
- <lazy-pair>
- <macro>
- <method>
- <next-method>
- <ordered-dictionary>
- <promise>
- <read-context>
- <read-reference>
- <sequence>
- <slot-accessor>
- <string-pointer>
- <syntactic-closure>
- <syntax-pattern>
- <syntax-rules>
- <syntax>
- <undefined-object>
- <unknown>
- <uvector>
- <weak-hash-table>
- gauche.mop.validator
- <validator-mixin>
- gauche.record
- <record>
- gauche.time
- <time-result>
- gauche.uvector
- <uvector>
- rfc.mime
- <mime-part>
- text.csv
- <csv>
- control.job
- ドキュメントの修正(案)
- yamasushi(2013/04/04 22:44:55 UTC)クラスの記述はあるがインデクスを生成していない箇所を修正
diff --git a/doc/corelib.texi b/doc/corelib.texi index b069a4e..5905ca5 100644 --- a/doc/corelib.texi +++ b/doc/corelib.texi @@ -19199,6 +19199,7 @@ to the POSIX-time (number of seconds since Epoch). @subsubheading SRFI time @deftp {Builtin Class} <time> +@clindex time @c EN The @code{<time>} object also represents a point of time. @c JP diff --git a/doc/modgauche.texi b/doc/modgauche.texi index 9a38c59..53a08de 100644 --- a/doc/modgauche.texi +++ b/doc/modgauche.texi @@ -2075,6 +2075,7 @@ the C world, and vice versa. The maybe variation is only meaningful when the C type is a pointer type. @deftp {Class} <cgen-type> +@clindex cgen-type An instance of this class represents a stub type. It can be looked up by name such as @code{<const-cstring>} by @code{cgen-type-from-name}. @@ -3522,6 +3523,7 @@ in the increasing order of keys. @c NODE 汎用ディクショナリ @deftp {Class} <bimap> +@clindex bimap Provides a bidirectional map (@emph{bimap}), a relation between two set of values, of which you can lookup both ways. @@ -5424,6 +5426,7 @@ but the current version doesn't implement it. @subheading Listener API @deftp {Class} <listener> +@clindex listener @c EN An object that maintains the state of a repl session. It has many external slots to customize its behavior. diff --git a/doc/modutil.texi b/doc/modutil.texi index 179578b..028b8cd 100644 --- a/doc/modutil.texi +++ b/doc/modutil.texi @@ -1937,6 +1937,7 @@ is returned. Otherwise, an error is signaled. @end defun @deftp {Class} <dbi-connection> +@clindex dbi-connection @c EN The base class of a connection to a database system. Each driver defines a subclass of this to keep information about @@ -1992,6 +1993,7 @@ Returns a list of module names of known drivers. @end defun @deftp {Class} <dbi-driver> +@clindex dbi-driver @c EN The base class of a driver. You usually don't need to see this as far as you're using the high-level @code{dbi} API. @@ -2122,6 +2124,7 @@ always surround names by double quotes. @end deffn @deftp {Class} <dbi-query> +@clindex dbi-query @c EN Holds information about prepared query, created by @code{dbi-prepare}. The following slots are defined. @@ -6055,6 +6058,7 @@ Calls @code{AllocConsole} and @code{FreeConsole}, respectively. @end defun @deftp {Class} <win:console-screen-buffer-info> +@clindex win:console-screen-buffer-info [Windows] @defivar {<win:console-screen-buffer-info>} size.x @@ -6106,6 +6110,7 @@ Calls @code{AllocConsole} and @code{FreeConsole}, respectively. @subsubheading Console input/output @deftp {Class} <win:input-record> +@clindex win:input-record [Windows] @defivar {<win:input-record>} event-type @@ -10584,6 +10589,8 @@ would be a simple @code{<error>} condition. @deftp {Class} <deflating-port> @deftpx {Class} <inflating-port> +@clindex deflating-port +@clindex inflating-port @c EN Compression and decompression functions are provided via ports. A @emph{deflating port} is an output port @@ -18630,6 +18637,7 @@ util.rbtreeのAPIはハッシュテーブルのAPIに似せて作られており @end deftp @deftp {Class} <rbtree> +@clindex rbtree @c EN A class for red black trees. Inherits @code{<sequence>}, so that you can apply sequence APIs on a red black tree. @@ -19118,6 +19126,7 @@ common methods. @c COMMON @deftp {Class} <relation> +@clindex relation @c EN An abstract base class of relations. @c JP @@ -19356,9 +19365,11 @@ you can write like this: @c COMMON @deftp {Class} <simple-relation> +@clindex simple-relation @end deftp @deftp {Class} <object-set-relation> +@clindex object-set-relation @end deftp @c ---------------------------------------------------------------------- @@ -20323,6 +20334,7 @@ Trieは@code{<collection>}を継承しており、コレクションフレーム @end deftp @deftp {Class} <trie> +@clindex trie @c EN A class for Trie. No slots are intended for public. Use the following procedures to operate on tries.
(yamasushi修正されました。(2013/04/06 03:51:28 UTC))
- yamasushi(2013/04/04 22:44:55 UTC)クラスの記述はあるがインデクスを生成していない箇所を修正