Document Prolog predicate classes

For describing predicate parameters in the javadoc we use '+' as
indicator for input mode and '-' as indicator for output mode (see
[1,2]).

[1] https://www.swi-prolog.org/pldoc/man?section=preddesc
[2] https://stackoverflow.com/questions/4220651/question-mark-plus-minus-preceding-prolog-variable-names

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I3195563311fbca02b7f42100fa1e90a8fc90746d
This commit is contained in:
Edwin Kempin
2019-12-30 14:52:44 +01:00
parent 5a099946ac
commit e8e79c94cc
12 changed files with 141 additions and 2 deletions

View File

@@ -22,6 +22,16 @@ import com.googlecode.prolog_cafe.lang.Predicate;
import com.googlecode.prolog_cafe.lang.Prolog;
import com.googlecode.prolog_cafe.lang.Term;
/**
* Prolog predicate for the number of unresolved comments of a change.
*
* <p>Checks that the term that is provided as input to this Prolog predicate is an integer atom
* that matches the number of unresolved comments of the change.
*
* <pre>
* 'unresolved_comments_count'(-NumberOfUnresolvedComments)
* </pre>
*/
public class PRED_unresolved_comments_count_1 extends Predicate.P1 {
public PRED_unresolved_comments_count_1(Term a1, Operation n) {
arg1 = a1;