From 19796a26bb7573f403a05a79d78a0d9b6852d6ae Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Tue, 7 Jun 2016 09:15:21 -0700 Subject: [PATCH] factor: fix docs. vocab-roots get [ vocabs-from ] map concat [ modern-docs-path ] map [ exists? ] filter [ dup . flush path>literals ] map-zip --- collections/bit-arrays/bit-arrays-docs.factor | 2 +- .../bit-vectors/bit-vectors-docs.factor | 2 +- collections/byte-arrays/hex/hex-docs.factor | 2 +- .../persistent/vectors/vectors-docs.factor | 2 +- .../specialized-arrays-docs.factor | 4 ++-- .../specialized-vectors-docs.factor | 6 ++--- .../suffix-arrays/suffix-arrays-docs.factor | 2 +- collections/trees/avl/avl-docs.factor | 2 +- collections/trees/splay/splay-docs.factor | 2 +- collections/trees/trees-docs.factor | 4 ++-- core/classes/tuple/tuple-docs.factor | 2 +- core/slots/slots-docs.factor | 4 ++-- core/typed/typed-docs.factor | 4 ++-- .../apple-script/apple-script-docs.factor | 2 +- ffi/cocoa/subclassing/subclassing-docs.factor | 4 ++-- ffi/python/syntax/syntax-docs.factor | 6 ++--- ffi/windows/com/syntax/syntax-docs.factor | 4 ++-- frameworks/gpu/render/render-docs.factor | 2 +- frameworks/gpu/shaders/shaders-docs.factor | 10 ++++---- frameworks/ui/ui-docs.factor | 4 ++-- language/alien/data/data-docs.factor | 2 +- language/alien/endian/endian-docs.factor | 16 ++++++------- language/alien/fortran/fortran-docs.factor | 12 +++++----- language/alien/syntax/syntax-docs.factor | 24 +++++++++---------- language/classes/struct/struct-docs.factor | 14 +++++------ language/descriptive/descriptive-docs.factor | 4 ++-- language/eval/eval-docs.factor | 4 ++-- language/literals/literals-docs.factor | 14 +++++------ language/match/match-docs.factor | 2 +- .../method-chains/method-chains-docs.factor | 8 +++---- language/multiline/multiline-docs.factor | 4 ++-- language/promises/promises-docs.factor | 2 +- language/slots/syntax/syntax-docs.factor | 10 ++++---- .../tuple-arrays/tuple-arrays-docs.factor | 2 +- language/variants/variants-docs.factor | 4 ++-- libs/html/templates/chloe/chloe-docs.factor | 4 ++-- libs/logging/logging-docs.factor | 2 +- libs/math/blas/matrices/matrices-docs.factor | 8 +++---- libs/math/blas/vectors/vectors-docs.factor | 8 +++---- .../derivatives/syntax/syntax-docs.factor | 2 +- libs/qw/qw-docs.factor | 2 +- libs/roles/roles-docs.factor | 22 ++++++++--------- .../unicode/categories/categories-docs.factor | 8 +++---- libs/xml/syntax/syntax-docs.factor | 8 +++---- tools/help/help-docs.factor | 6 ++--- tools/help/tips/tips-docs.factor | 2 +- tools/tools/walker/walker-docs.factor | 6 ++--- 47 files changed, 135 insertions(+), 135 deletions(-) diff --git a/collections/bit-arrays/bit-arrays-docs.factor b/collections/bit-arrays/bit-arrays-docs.factor index 1f9ac39085..6101d7f8c7 100644 --- a/collections/bit-arrays/bit-arrays-docs.factor +++ b/collections/bit-arrays/bit-arrays-docs.factor @@ -33,7 +33,7 @@ $nl about: "bit-arrays" -HELP: ?{ +HELP: \ ?{ { $syntax "?{ elements... }" } { $values { "elements" "a list of booleans" } } { $description "Marks the beginning of a literal bit array. Literal bit arrays are terminated by " { $link postpone\ } } "." } diff --git a/collections/bit-vectors/bit-vectors-docs.factor b/collections/bit-vectors/bit-vectors-docs.factor index 13f9fbac7d..77ec95c530 100644 --- a/collections/bit-vectors/bit-vectors-docs.factor +++ b/collections/bit-vectors/bit-vectors-docs.factor @@ -32,7 +32,7 @@ HELP: >bit-vector { $values { "seq" sequence } { "vector" bit-vector } } { $description "Outputs a freshly-allocated bit vector with the same elements as a given sequence." } ; -HELP: ?V{ +HELP: \ ?V{ { $syntax "?V{ elements... }" } { $values { "elements" "a list of booleans" } } { $description "Marks the beginning of a literal bit vector. Literal bit vectors are terminated by " { $link postpone\ } } "." } diff --git a/collections/byte-arrays/hex/hex-docs.factor b/collections/byte-arrays/hex/hex-docs.factor index 6b1a143cf0..d62f2c7cee 100644 --- a/collections/byte-arrays/hex/hex-docs.factor +++ b/collections/byte-arrays/hex/hex-docs.factor @@ -3,6 +3,6 @@ in: byte-arrays.hex USING: byte-arrays help.markup help.syntax ; -HELP: HEX{ +HELP: \ HEX{ { $syntax "HEX{ 0123 45 67 89abcdef }" } { $description "Constructs a " { $link byte-array } " from data specified in hexadecimal format. Whitespace between the curly braces is ignored. There must be an even number of hex digits or an error is thrown." } ; diff --git a/collections/persistent/vectors/vectors-docs.factor b/collections/persistent/vectors/vectors-docs.factor index fe7a248595..cba9afe8f7 100644 --- a/collections/persistent/vectors/vectors-docs.factor +++ b/collections/persistent/vectors/vectors-docs.factor @@ -1,7 +1,7 @@ USING: help.markup help.syntax kernel math sequences ; in: persistent.vectors -HELP: PV{ +HELP: \ PV{ { $syntax "PV{ elements... }" } { $description "Parses a literal " { $link persistent-vector } "." } ; diff --git a/collections/specialized-arrays/specialized-arrays-docs.factor b/collections/specialized-arrays/specialized-arrays-docs.factor index d9dda1262a..efe3ab63ac 100644 --- a/collections/specialized-arrays/specialized-arrays-docs.factor +++ b/collections/specialized-arrays/specialized-arrays-docs.factor @@ -1,12 +1,12 @@ USING: help.markup help.syntax byte-arrays alien math sequences ; in: specialized-arrays -HELP: specialized-array: +HELP: \ specialized-array: { $syntax "specialized-array: type" } { $values { "type" "a C type" } } { $description "Brings a specialized array for holding values of " { $snippet "type" } " into the vocabulary search path. The generated words are documented in " { $link "specialized-array-words" } "." } ; -HELP: SPECIALIZED-ARRAYS: +HELP: \ SPECIALIZED-ARRAYS: { $syntax "SPECIALIZED-ARRAYS: type type type ... ;" } { $values { "type" "a C type" } } { $description "Brings a set of specialized arrays for holding values of each " { $snippet "type" } " into the vocabulary search path. The generated words are documented in " { $link "specialized-array-words" } "." } ; diff --git a/collections/specialized-vectors/specialized-vectors-docs.factor b/collections/specialized-vectors/specialized-vectors-docs.factor index 9dcf2cb770..77aa1fe9ad 100644 --- a/collections/specialized-vectors/specialized-vectors-docs.factor +++ b/collections/specialized-vectors/specialized-vectors-docs.factor @@ -1,17 +1,17 @@ USING: help.markup help.syntax byte-vectors alien byte-arrays classes.struct ; in: specialized-vectors -HELP: specialized-vector: +HELP: \ specialized-vector: { $syntax "specialized-vector: type" } { $values { "type" "a C type" } } { $description "Brings a specialized vector for holding values of " { $snippet "type" } " into the vocabulary search path. The generated words are documented in " { $link "specialized-vector-words" } "." } ; -HELP: SPECIALIZED-VECTORS: +HELP: \ SPECIALIZED-VECTORS: { $syntax "SPECIALIZED-VECTORS: type type type ... ;" } { $values { "type" "a C type" } } { $description "Brings a set of specialized vectors for holding values of each " { $snippet "type" } " into the vocabulary search path. The generated words are documented in " { $link "specialized-vector-words" } "." } ; -{ postpone\ specialized-vector: postpone\ SPECIALIZED-VECTORS: } related-words +{ \ specialized-vector: \ SPECIALIZED-VECTORS: } related-words ARTICLE: "specialized-vector-words" "Specialized vector words" "The " { $link postpone\ specialized-vector: } " parsing word generates the specialized vector type if it hasn't been generated already, and adds the following words to the vocabulary search path, where " { $snippet "T" } " is the C type in question:" diff --git a/collections/suffix-arrays/suffix-arrays-docs.factor b/collections/suffix-arrays/suffix-arrays-docs.factor index 2015c375a4..129c1032a3 100644 --- a/collections/suffix-arrays/suffix-arrays-docs.factor +++ b/collections/suffix-arrays/suffix-arrays-docs.factor @@ -10,7 +10,7 @@ HELP: >suffix-array { "array" array } } { $description "Creates a suffix array from the input sequence. Suffix arrays are arrays of slices." } ; -HELP: SA{ +HELP: \ SA{ { $description "Creates a new literal suffix array at parse-time." } ; HELP: suffixes diff --git a/collections/trees/avl/avl-docs.factor b/collections/trees/avl/avl-docs.factor index 1db3cf9e60..478b3caf8c 100644 --- a/collections/trees/avl/avl-docs.factor +++ b/collections/trees/avl/avl-docs.factor @@ -1,7 +1,7 @@ USING: help.syntax help.markup assocs ; in: trees.avl -HELP: AVL{ +HELP: \ AVL{ { $syntax "AVL{ { key value }... }" } { $values { "key" "a key" } { "value" "a value" } } { $description "Literal syntax for an AVL tree." } ; diff --git a/collections/trees/splay/splay-docs.factor b/collections/trees/splay/splay-docs.factor index 846a26db13..08181fe75d 100644 --- a/collections/trees/splay/splay-docs.factor +++ b/collections/trees/splay/splay-docs.factor @@ -1,7 +1,7 @@ USING: help.syntax help.markup assocs ; in: trees.splay -HELP: SPLAY{ +HELP: \ SPLAY{ { $syntax "SPLAY{ { key value }... }" } { $values { "key" "a key" } { "value" "a value" } } { $description "Literal syntax for an splay tree." } ; diff --git a/collections/trees/trees-docs.factor b/collections/trees/trees-docs.factor index 8c21a83ac3..fa726bf904 100644 --- a/collections/trees/trees-docs.factor +++ b/collections/trees/trees-docs.factor @@ -1,7 +1,7 @@ USING: help.syntax help.markup assocs ; in: trees -HELP: TREE{ +HELP: \ TREE{ { $syntax "TREE{ { key value }... }" } { $values { "key" "a key" } { "value" "a value" } } { $description "Literal syntax for an unbalanced tree." } ; @@ -23,7 +23,7 @@ ARTICLE: "trees" "Binary search trees" tree >tree - postpone\ TREE{ + \ TREE{ } ; about: "trees" diff --git a/core/classes/tuple/tuple-docs.factor b/core/classes/tuple/tuple-docs.factor index cf1921b85a..580a0edb07 100644 --- a/core/classes/tuple/tuple-docs.factor +++ b/core/classes/tuple/tuple-docs.factor @@ -28,7 +28,7 @@ ARTICLE: "tuple-declarations" "Tuple slot declarations" { $list "class declaration: values must satisfy the class predicate" { "whether a slot is read only or not (" { $link read-only } ")" } - { "an initial value (" { $link initial: } ")" } + { "an initial value (" { $link \ initial: } ")" } } { $subsections "slot-read-only-declaration" diff --git a/core/slots/slots-docs.factor b/core/slots/slots-docs.factor index 52b4b42885..7d5501d1bc 100644 --- a/core/slots/slots-docs.factor +++ b/core/slots/slots-docs.factor @@ -62,7 +62,7 @@ $nl { $see-also "slots" "mirrors" } ; ARTICLE: "slot-initial-values" "Initial values of slots" -"An initial value for a slot can be specified with the " { $link initial: } " slot declaration attribute. For certain classes, the initial value is optional; in these cases, it does not need to be specified. For others, it is required. Initial values can be used independently of class declaration, but if specified, the value must satisfy the class predicate." +"An initial value for a slot can be specified with the " { $link \ initial: } " slot declaration attribute. For certain classes, the initial value is optional; in these cases, it does not need to be specified. For others, it is required. Initial values can be used independently of class declaration, but if specified, the value must satisfy the class predicate." $nl "The following classes have default initial values:" { $table @@ -77,7 +77,7 @@ $nl { $list { "If the class is a union or mixin class which " { $emphasis "contains" } " one of the above known classes, then the initial value of the class is that of the known class, with preference given to classes earlier in the list. For example, if the slot is declared " { $link object } " (this is the default), the initial value is " { $link f } ". Similarly for " { $link sequence } " and " { $link assoc } "." } { "If the class is a tuple class, the initial value of the slot is a new, shared instance of the class created with " { $link new } "." } - { "Otherwise, a " { $link bad-initial-value } " error is thrown. In this case, an initial value must be specified explicitly using " { $link initial: } "." } + { "Otherwise, a " { $link bad-initial-value } " error is thrown. In this case, an initial value must be specified explicitly using " { $link \ initial: } "." } } "A word can be used to check if a class has an initial value or not:" { $subsections initial-value } ; diff --git a/core/typed/typed-docs.factor b/core/typed/typed-docs.factor index 819652c2eb..cce5e8011d 100644 --- a/core/typed/typed-docs.factor +++ b/core/typed/typed-docs.factor @@ -2,7 +2,7 @@ USING: arrays effects help.markup help.syntax locals math quotations words ; in: typed -HELP: TYPED: +HELP: \ TYPED: { $syntax "TYPED: word ( a b: class ... -- x: class y ... ) body ;" } @@ -20,7 +20,7 @@ TYPED: add-floats ( a: float b: float -- c: float ) 1 2+1/2 add-floats ." "3.5" } } ; -HELP: TYPED:: +HELP: \ TYPED:: { $syntax "TYPED:: word ( a b: class ... -- x: class y ... ) body ;" } diff --git a/ffi/cocoa/apple-script/apple-script-docs.factor b/ffi/cocoa/apple-script/apple-script-docs.factor index 53718cd052..b6ecdae878 100644 --- a/ffi/cocoa/apple-script/apple-script-docs.factor +++ b/ffi/cocoa/apple-script/apple-script-docs.factor @@ -7,7 +7,7 @@ HELP: run-apple-script { $description "Runs the provided uncompiled AppleScript code." } { $notes "Currently, return values are unsupported." } ; -HELP: APPLESCRIPT: +HELP: \ APPLESCRIPT: { $syntax "APPLESCRIPT: word ...applescript... APPLESCRIPT;" } { $values { "word" "a new word to define" } { "...applescript..." "AppleScript source text" } } { $description "Defines a word that when called will run the provided uncompiled AppleScript. The word has stack effect " { $snippet "( -- )" } " due to return values being currently unsupported." } ; diff --git a/ffi/cocoa/subclassing/subclassing-docs.factor b/ffi/cocoa/subclassing/subclassing-docs.factor index 22ae8787a2..64111d4724 100644 --- a/ffi/cocoa/subclassing/subclassing-docs.factor +++ b/ffi/cocoa/subclassing/subclassing-docs.factor @@ -1,7 +1,7 @@ USING: help.markup help.syntax strings alien hashtables ; in: cocoa.subclassing -HELP: CLASS: +HELP: \ CLASS: { $syntax "CLASS: name < superclass protocols... imeth... ;" } { $values { "name" "a new class name" } { "superclass" "a superclass name" } { "protocols" "zero or more protocol names" } { "imeth" "instance method definitions using " { $link postpone\ METHOD: } } } { $description "Defines a new Objective C class. Instance methods are defined with the " { $link postpone\ METHOD: } " parsing word." @@ -10,7 +10,7 @@ $nl { define-objc-class postpone\ CLASS: postpone\ METHOD: } related-words -HELP: METHOD: +HELP: \ METHOD: { $syntax "METHOD: return foo: type1 arg1 bar: type2 arg2 baz: ... [ body ] ;" } { $values { "return" "a C type name" } { "type1" "a C type name" } { "arg1" "a local variable name" } { "body" "arbitrary code" } } { $description "Defines a method inside of a " { $link postpone\ CLASS: } " form." } ; diff --git a/ffi/python/syntax/syntax-docs.factor b/ffi/python/syntax/syntax-docs.factor index 30f643ad82..eff9d46b80 100644 --- a/ffi/python/syntax/syntax-docs.factor +++ b/ffi/python/syntax/syntax-docs.factor @@ -1,7 +1,7 @@ in: python.syntax USING: hashtables python.syntax help.markup help.syntax ; -HELP: PY-FROM: +HELP: \ PY-FROM: { $syntax "PY-FROM: module => name-effects ;" } { $values { "module" "fully qualified name of a python module" } @@ -16,7 +16,7 @@ HELP: PY-FROM: } } ; -HELP: PY-QUALIFIED-FROM: +HELP: \ PY-QUALIFIED-FROM: { $syntax "PY-QUALIFIED-FROM: module => name-effects ;" } { $values { "module" "fully qualified name of a python module" } @@ -26,7 +26,7 @@ HELP: PY-QUALIFIED-FROM: "Like " { $link \ PY-FROM: } " except all words are created with module as the given prefix." } ; -HELP: PY-METHODS: +HELP: \ PY-METHODS: { $syntax "PY-METHODS: class => name-effects ;" } { $values { "class" "name of a class to associate the bindings with" } diff --git a/ffi/windows/com/syntax/syntax-docs.factor b/ffi/windows/com/syntax/syntax-docs.factor index 45cac35391..7c07409e39 100644 --- a/ffi/windows/com/syntax/syntax-docs.factor +++ b/ffi/windows/com/syntax/syntax-docs.factor @@ -1,11 +1,11 @@ USING: help.markup help.syntax io kernel math quotations ; in: windows.com.syntax -HELP: guid: +HELP: \ guid: { $syntax "guid: \"{01234567-89ab-cdef-0123-456789abcdef}\"" } { $description "\nCreate a COM globally-unique identifier (GUID) literal at parse time, and push it onto the data stack." } ; -HELP: COM-INTERFACE: +HELP: \ COM-INTERFACE: { $syntax "COM-INTERFACE: ( ) ( ) diff --git a/frameworks/gpu/render/render-docs.factor b/frameworks/gpu/render/render-docs.factor index 12a48f5009..a1a84643df 100644 --- a/frameworks/gpu/render/render-docs.factor +++ b/frameworks/gpu/render/render-docs.factor @@ -40,7 +40,7 @@ HELP: } { $description "Constructs a " { $link multi-index-range } " tuple." } ; -HELP: UNIFORM-TUPLE: +HELP: \ UNIFORM-TUPLE: { $syntax "UNIFORM-TUPLE: class-name { \"slot\" uniform-type dimension } { \"slot\" uniform-type dimension } diff --git a/frameworks/gpu/shaders/shaders-docs.factor b/frameworks/gpu/shaders/shaders-docs.factor index 1dbc533ed3..30dcc215a0 100644 --- a/frameworks/gpu/shaders/shaders-docs.factor +++ b/frameworks/gpu/shaders/shaders-docs.factor @@ -29,16 +29,16 @@ HELP: feedback-format: { $syntax "feedback-format: vertex-format" } { $description "When used as part of a " { $link postpone\ GLSL-PROGRAM: } " definition, this syntax specifies the " { $link vertex-format } " in which transform feedback output will be generated." } ; -HELP: GLSL-PROGRAM: +HELP: \ GLSL-PROGRAM: { $syntax "GLSL-PROGRAM: program-name shader shader ... [vertex-format vertex-format ...] [feedback-format: vertex-format] ;" } { $description "Defines a new " { $link program } " named " { $snippet "program-name" } ". When the program is instantiated with " { $link } ", it will link together instances of all of the specified " { $link shader } "s to create the program instance. If any " { $link vertex-format } "s are specified, their attributes will be pre-assigned attribute indexes at link time, to ensure that their indexes remain constant if the program is refreshed with " { $link refresh-program } ". A transform feedback vertex format may optionally be specified with " { $link postpone\ feedback-format: } "; if the program is used to collect transform feedback, the given vertex format will be used for the output." } { $notes "Transform feedback requires OpenGL 3.0 or one of the " { $snippet "GL_EXT_transform_feedback" } " or " { $snippet "GL_ARB_transform_feedback" } " extensions." } ; -HELP: GLSL-SHADER-FILE: +HELP: \ GLSL-SHADER-FILE: { $syntax "GLSL-SHADER-FILE: shader-name shader-kind \"filename\" ;" } { $description "Defines a new " { $link shader } " of kind " { $link shader-kind } " named " { $snippet "shader-name" } ". The shader will read its source code from " { $snippet "filename" } " in the current Factor source file's directory." } ; -HELP: GLSL-SHADER: +HELP: \ GLSL-SHADER: { $syntax "GLSL-SHADER: shader-name shader-kind shader source @@ -46,7 +46,7 @@ shader source ;" } { $description "Defines a new " { $link shader } " of kind " { $link shader-kind } " named " { $snippet "shader-name" } ". The shader will read its source code from the current Factor source file between the " { $snippet "GLSL-SHADER:" } " line and the first subsequent line with a single semicolon on it." } ; -HELP: VERTEX-FORMAT: +HELP: \ VERTEX-FORMAT: { $syntax "VERTEX-FORMAT: format-name { \"attribute\"/f component-type dimension normalize? } { \"attribute\"/f component-type dimension normalize? } @@ -54,7 +54,7 @@ HELP: VERTEX-FORMAT: { \"attribute\"/f component-type dimension normalize? } ;" } { $description "Defines a new binary " { $link vertex-format } " for structuring vertex data stored in " { $link buffer } "s. Each " { $snippet "attribute" } " name either corresponds to an input parameter of a vertex shader, or is " { $link f } " to include padding in the vertex format. The " { $link component-type } " determines the format of the components, and the " { $snippet "dimension" } " determines the number of components. If the " { $snippet "component-type" } " is an integer type and " { $snippet "normalize?" } " is true, the component values will be scaled to the range 0.0 to 1.0 when fed to the vertex shader; otherwise, they will be cast to floats retaining their integral values." } ; -HELP: VERTEX-STRUCT: +HELP: \ VERTEX-STRUCT: { $syntax "VERTEX-STRUCT: struct-name format-name" } { $description "Defines a struct class (like " { $link postpone\ STRUCT: } ") with the same binary format and component types as the given " { $link vertex-format } "." } ; diff --git a/frameworks/ui/ui-docs.factor b/frameworks/ui/ui-docs.factor index 2bf62b0e0c..2d7092ef98 100644 --- a/frameworks/ui/ui-docs.factor +++ b/frameworks/ui/ui-docs.factor @@ -343,7 +343,7 @@ HELP: textured-background HELP: dialog-window { $description "Provides a hint to the window manager to create a floating, dialog-style window. Currently, this is only implemented for the GTK backend." } ; -HELP: WINDOW: +HELP: \ WINDOW: { $syntax "WINDOW: window-word { attributes } attribute-code ;" } { $description "Defines a word for the current vocabulary named " { $snippet "window-word" } " that opens a UI window when run. The " { $snippet "attributes" } " specify the key-value pairs of the window's " { $link world-attributes } ". The " { $snippet "attribute-code" } " is run with the " { $snippet "world-attributes" } " on the stack; this allows the word to construct gadget objects to place in the " { $snippet "gadget" } " slot or set other runtime-dependent world attributes." } @@ -357,7 +357,7 @@ WINDOW: hello { { title \"Hi\" } } \"Hello world\"