changeset 6:8f2689f2989d

Added documentation.
author samer
date Tue, 28 Feb 2012 22:50:44 +0000
parents 821f56d94b18
children 9b52fefb48c9
files prolog/plosc.pl
diffstat 1 files changed, 5 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/prolog/plosc.pl	Fri Feb 24 18:09:47 2012 +0000
+++ b/prolog/plosc.pl	Tue Feb 28 22:50:44 2012 +0000
@@ -94,7 +94,11 @@
 %  Gets the current OSC time in seconds and 1/2^64 ths of second.
 osc_now(osc_ts(Secs,Fracs)) :- osc_now(Secs,Fracs).
 
-
+%% osc_time_ts(+Time:float,-TS:osc_timestamp) is det.
+%% osc_time_ts(-Time:float,+TS:osc_timestamp) is det.
+%
+%  Convert between floating point time as returned by get_time/1 and OSC
+%  timestamp structure as returned by osc_now/1.
 osc_time_ts(Time,osc_ts(Secs,Fracs)) :-
 	(	var(Time) -> time_from_ts(Time,Secs,Fracs)
 	;	time_to_ts(Time,Secs,Fracs)).