documentation.

This commit is contained in:
Vitor Santos Costa
2017-07-24 18:20:00 +01:00
parent 023c254d03
commit 63a1957d8e
16 changed files with 337 additions and 367 deletions

View File

@@ -26,7 +26,8 @@
`use_module(library(dbusage))` command.
*/
/** @pred db_usage
/** @pred db_usage
Give general overview of data-base usage in the system.
*/
db_usage :-

View File

@@ -309,7 +309,7 @@ flag_group_chk(FlagGroup):-
flag_type(Type):-
flags_type_definition(Type, _, _).
% flags_type_definition(TypeName, TypeHandler, TypeValidator).
%% @pred flags_type_definition(TypeName, TypeHandler, TypeValidator).
flags_type_definition(nonvar, nonvar, true).
flags_type_definition(atom, atom, true).
flags_type_definition(atomic, atomic, true).
@@ -586,4 +586,4 @@ defined_flag(FlagName, FlagGroup, FlagType, DefaultValue, Description, Access, H
nonvar(FlagName), nonvar(FlagGroup),
'$defined_flag$'(FlagName, FlagGroup, FlagType, DefaultValue, Description, Access, Handler).
%% @}
%% @}

View File

@@ -147,7 +147,7 @@ open_log(F) :-
).
/**
* @pred `<--`( +Tag , :Goal )
* @pred +Tag <-- :Goal
*
* @param [in] output goal _Goal_ before and after being evaluated, but only
* taking the first solution. The _Tag_ must be an atom or a string.

View File

@@ -150,7 +150,7 @@ min(red(Right,_,_,_), Key, Val) :-
min(black(Right,_,_,_), Key, Val) :-
min(Right,Key,Val).
%% @pred rb_max(+T, -Key, -Value) is semidet.
%% @pred rb_max( +T, -Key, -Value) is semidet.
%
% Key is the maximal key in T, and is associated with Val.
@@ -612,8 +612,8 @@ pretty_print(black(L,K,_,R),D) :-
rb_delete(t(Nil,T), K, t(Nil,NT)) :-
delete(T, K, _, NT, _).
%% rb_delete(+T, +Key, -TN).
%% rb_delete(+T, +Key, -Val, -TN).
%% @pred rb_delete(+T, +Key, -TN).
%% @pred rb_delete(+T, +Key, -Val, -TN).
%
% Delete element with key Key from the tree T, returning the value
% Val associated with the key and a new tree TN.
@@ -648,7 +648,7 @@ delete(black(L,_,V,R), _, V, OUT, Flag) :-
% K == K0,
delete_black_node(L,R,OUT,Flag).
%% rb_del_min(+T, -Key, -Val, -TN)
%% @pred rb_del_min(+T, -Key, -Val, -TN)
%
% Delete the least element from the tree T, returning the key Key,
% the value Val associated with the key and a new tree TN.
@@ -668,7 +668,7 @@ del_min(black(L,K0,V0,R), K, V, Nil, NT, Flag) :-
fixup_left(Flag0,black(NL,K0,V0,R),NT, Flag).
%% rb_del_max(+T, -Key, -Val, -TN)
%% @pred rb_del_max( +T, -Key, -Val, -TN)
%
% Delete the largest element from the tree T, returning the key
% Key, the value Val associated with the key and a new tree TN.