Start adding srfi-234 docs

shirok · Sep 30, 2024 · c61c66f · c61c66f
1 parent 70bd778
commit c61c66f
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 5 deletions.
diff --git a/doc/modsrfi.texi b/doc/modsrfi.texi
@@ -102,6 +102,7 @@ R7RSライブラリとしては@code{(srfi 13)})ということに注意して
 * Composing comparators::       srfi.228
 * Tagged procedures::           srfi.229
 * Flexible curried procedures::  srfi.232
+* Topological sorting::         srfi.234
 * Combinators (SRFI)::          srfi.235
 * Codesets::                    srfi.238
 * Destructuring lists::         srfi.239
@@ -16020,7 +16021,7 @@ is signaled.
 
 
 @c ----------------------------------------------------------------------
-@node Flexible curried procedures, Combinators (SRFI), Tagged procedures, Library modules - SRFIs
+@node Flexible curried procedures, Topological sorting, Tagged procedures, Library modules - SRFIs
 @section @code{srfi.232} - Flexible curried procedures
 @c NODE 柔軟なカリー化された手続き, @code{srfi.232} - 柔軟なカリー化された手続き
 
@@ -16194,7 +16195,58 @@ A shorthand of @code{(define name (curried formals body @dots{}))}.
 @end defmac
 
 @c ----------------------------------------------------------------------
-@node Combinators (SRFI), Codesets, Flexible curried procedures, Library modules - SRFIs
+@node Topological sorting, Combinators (SRFI), Flexible curried procedures, Library modules - SRFIs
+@section @code{srfi.234} - Topological sorting
+@c NODE トポロジカルソート, @code{srfi.234} - トポロジカルソート
+
+@deftp {Module} srfi.234
+@mdindex srfi.234
+This module implements topological sort algorithm.
+
+The SRFI is an enhancement of Gauche's @code{util.toposort} module
+(@pxref{Topological sort (legacy)}).
+As this SRFI is finalized, we encourage new code to use this for
+richer features and portability.  Original @code{util.toposort} has
+become a thin wrapper of this module.
+@end deftp
+
+@defun topological-sort graph :optional eq node-array
+[SRFI-234]
+@c MOD srfi.234
+@end defun
+
+@defun topological-sort/details graph :optional eq node-array
+[SRFI-234]
+@c MOD srfi.234
+@end defun
+
+@defun edgelist->graph edgelist :optional retriever
+[SRFI-234]
+@c MOD srfi.234
+@end defun
+
+@defun edgelist/inverted->graph edgelist :optional retriever
+[SRFI-234]
+@c MOD srfi.234
+@end defun
+
+@defun graph->edgelist graph
+[SRFI-234]
+@c MOD srfi.234
+@end defun
+
+@defun graph->edgelist/inverted graph
+[SRFI-234]
+@c MOD srfi.234
+@end defun
+
+@defun connected-components graph
+[SRFI-234]
+@c MOD srfi.234
+@end defun
+
+@c ----------------------------------------------------------------------
+@node Combinators (SRFI), Codesets, Topological sorting, Library modules - SRFIs
 @section @code{srfi.235} - Combinators (SRFI)
 @c NODE コンビネータ (SRFI), @code{srfi.235} - コンビネータ (SRFI)
 

diff --git a/doc/modutil.texi b/doc/modutil.texi
@@ -37767,9 +37767,10 @@ Implements topological sort algorithm.
 
 @c EN
 SRFI-234 now defines a superset of the functionalities this module provides.
-New code should use it instead of this module.
+New code should use it instead of this module (@pxref{Topological sorting}).
 @c JP
-今では、SRFI-234がこのモジュールの上位互換の機能を提供しています。
+今では、SRFI-234がこのモジュールの上位互換の機能を提供しています
+(@ref{Topological sorting}参照)。
 新しいコードはSRFI-234を使ってください。
 @c COMMON
 @end deftp

diff --git a/src/srfis.scm b/src/srfis.scm
@@ -1663,9 +1663,11 @@ srfi-234, srfi-234
 
 Topological sorting
 Supported by the module @code{srfi.234}
+(@pxref{Topological sorting}).
 
 トポロジカルソート
-@code{srfi.234}でサポートされます。
+@code{srfi.234}でサポートされます
+(@ref{Topological sorting}参照)。
 
 
 srfi-235, srfi-235