diff options
| author | Mark Thom <markjordanthom@gmail.com> | 2024-09-16 17:41:18 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-16 17:41:18 -0600 |
| commit | a898d7a667269f1c06a5d9b17aff4520f296414b (patch) | |
| tree | d9a6494366842c374dde27aa3fbbe28374c68c01 | |
| parent | 12a61cdff8abcd5d5d3c9a8bc7a5430f9764eae9 (diff) | |
| parent | 238f1bd639f658ee3e3e288e8e2ae915d8ab2cf5 (diff) | |
Merge pull request #2558 from bakaq/error_to_doclog
Convert library(error) docs to Doclog format
| -rw-r--r-- | src/lib/error.pl | 71 |
1 files changed, 33 insertions, 38 deletions
diff --git a/src/lib/error.pl b/src/lib/error.pl index 38a93214..fc3b9712 100644 --- a/src/lib/error.pl +++ b/src/lib/error.pl @@ -14,31 +14,29 @@ :- meta_predicate check_(1, ?, ?). -/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - must_be(Type, Term) - - This predicate is intended for type-checks of built-in predicates. - - It asserts that Term is: - - 1) instantiated *and* - 2) instantiated to an instance of the given Type. - - It corresponds to usage mode +Term. - - Currently, the following types are supported: - - - atom - - boolean - - character - - chars - - in_character - - integer - - list - - octet_character - - octet_chars - - term -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ +%% must_be(Type, Term) +% +% This predicate is intended for type-checks of built-in predicates. +% +% It asserts that Term is: +% +% 1) instantiated *and* +% 2) instantiated to an instance of the given Type. +% +% It corresponds to usage mode +Term. +% +% Currently, the following types are supported: +% +% - atom +% - boolean +% - character +% - chars +% - in_character +% - integer +% - list +% - octet_character +% - octet_chars +% - term must_be(Type, Term) :- must_be_(type, Type), @@ -142,19 +140,16 @@ type(boolean). type(term). type(not_less_than_zero). -/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - can_be(Type, Term) - - This predicate is intended for type-checks of built-in predicates. - - It asserts that there is a substitution which, if applied to Term, - makes it an instance of Type. - - It corresponds to usage mode ?Term. - - It supports the same types as must_be/2. -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ - +%% can_be(Type, Term) +% +% This predicate is intended for type-checks of built-in predicates. +% +% It asserts that there is a substitution which, if applied to Term, +% makes it an instance of Type. +% +% It corresponds to usage mode ?Term. +% +% It supports the same types as must_be/2. can_be(Type, Term) :- must_be(type, Type), |