- examples(+Objs, +Options)[private]
- Include examples for the predicate PI.
- example(+PI, -File, -RefType) is nondet[private]
- Get an example.
- ex_code(File, N, Size, XRef)[private]
- index_examples is det
- index_examples(+Backlog) is det
- reindex_examples is det
- Update the example index.
- To be done
- - We only have to reprocess modified or new examples.
- ex_xref(?Id, -Code, -XRef) is nondet
- ex_repo(-Dir) is nondet[private]
- True when Dir is a toplevel example directory
- ex_file(-File) is nondet[private]
- True when File is the name of an example file
- ex_file_dom(+File, -DOM) is det[private]
- dom_code(+DOM, -Code, -Attrs) is nondet[private]
- dom_property(+DOM, ?Prop, -ValueDOM) is nondet[private]
- code_xref(+Code, -XRef) is det[private]
- Cross-reference a code fragment
- xref_terms(+Terms, -XRef:dict) is det[private]
- Cross-reference a list of terms, returning a dict that contains:
- defined:OrdSetOfPI
- called:OrdSetOfPI
- required:OrdSetOfPI
- error:SetOfErrorTerms
Note that XRef.required is XRef.called \ built-in \XRef.defined.
- pull_examples[private]
- Do a git pull on the examples and update the index.
Re-exported predicates
The following predicates are exported from this file while their implementation is defined in imported modules or non-module files loaded by this module.
- index_examples is det
- index_examples(+Backlog) is det
- reindex_examples is det
- Update the example index.
- To be done
- - We only have to reprocess modified or new examples.
Undocumented predicates
The following predicates are exported, but not or incorrectly documented.
- examples(Arg1, Arg2, Arg3, Arg4)