steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Move synopsis* from definitions to see

db4
Slava Pestov 2009-03-23 19:25:10 -05:00
parent e4c1c1cc2a
commit 6f4e5b4bd9
4 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
basis/see/see-docs.factor
View File

@ -50,6 +50,9 @@ $nl
"Printing a definition:"
{ $subsection see }
"Printing the methods defined on a generic word or class (see " { $link "objects" } "):"
{ $subsection see-methods } ;
{ $subsection see-methods }
"Definition specifiers implementing the " { $link "definition-protocol" } " should also implement the " { $emphasis "see protocol" } ":"
{ $subsection see* }
{ $subsection synopsis* } ;
ABOUT: "see"

2
basis/see/see.factor
View File

@ -10,6 +10,8 @@ prettyprint.sections sequences sets sorting strings summary
words words.symbol ;
IN: see
GENERIC: synopsis* ( defspec -- )
GENERIC: see* ( defspec -- )
: see ( defspec -- ) see* nl ;

4
core/definitions/definitions-docs.factor
View File

@ -13,9 +13,9 @@ $nl
"Definitions can answer a sequence of definitions they directly depend on:"
{ $subsection uses }
"Definitions must implement a few operations used for printing them in source form:"
{ $subsection synopsis* }
{ $subsection definer }
{ $subsection definition } ;
{ $subsection definition }
{ $see-also "see" } ;
ARTICLE: "definition-crossref" "Definition cross referencing"
"A common cross-referencing system is used to track definition usages:"

2
core/generic/generic-docs.factor
View File

@ -62,7 +62,7 @@ ARTICLE: "method-combination" "Custom method combination"
{ { $link POSTPONE: HOOK: } { $link hook-combination } }
{ { $link POSTPONE: MATH: } { $link math-combination } }
}
"Developing a custom method combination requires that a parsing word calling " { $link define-generic } " be defined; additionally, it is a good idea to implement the definition protocol words " { $link definer } " and " { $link synopsis* } " on the class of words having this method combination, to properly support developer tools."
"Developing a custom method combination requires that a parsing word calling " { $link define-generic } " be defined; additionally, it is a good idea to implement the " { $link "definition-protocol" } " on the class of words having this method combination, to properly support developer tools."
$nl
"The combination quotation passed to " { $link define-generic } " has stack effect " { $snippet "( word -- quot )" } ". It's job is to call various introspection words, including at least obtaining the set of methods defined on the generic word, then combining these methods in some way to produce a quotation."
{ $see-also "generic-introspection" } ;