From: uz <uz@b7a2c559-68d2-44c3-8de9-860c34a00d81>
Date: Mon, 6 Feb 2012 21:23:36 +0000 (+0000)
Subject: Added docs for clock().
X-Git-Tag: V2.13.3~12
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=2116acd8c703decec0d05c16b9c36b6eed5f8a4d;p=cc65

Added docs for clock().


git-svn-id: svn://svn.cc65.org/cc65/trunk@5480 b7a2c559-68d2-44c3-8de9-860c34a00d81
---

diff --git a/doc/funcref.sgml b/doc/funcref.sgml
index 3f9de4267..c997de198 100644
--- a/doc/funcref.sgml
+++ b/doc/funcref.sgml
@@ -616,7 +616,7 @@ communication.
 <itemize>
 <!-- <item><ref id="_systime" name="_systime"> -->
 <!-- <item><ref id="asctime" name="asctime"> -->
-<!-- <item><ref id="clock" name="clock"> -->
+<item><ref id="clock" name="clock">
 <!-- <item><ref id="ctime" name="ctime"> -->
 <!-- <item><ref id="gmtime" name="gmtime"> -->
 <!-- <item><ref id="localtime" name="localtime"> -->
@@ -1513,6 +1513,30 @@ used in presence of a prototype.
 </quote>
 
 
+<sect1>clock<label id="clock"><p>
+
+<quote>
+<descrip>
+<tag/Function/Determine the processor time used.
+<tag/Header/<tt/<ref id="time.h" name="time.h">/
+<tag/Declaration/<tt/clock_t clock (void);/
+<tag/Description/The <tt/clock/ function returns an approximaton of processor
+time used by the program. The time is returned in implementation defined
+units. It can be converted to seconds by dividing by the value if the macro
+<tt/CLOCKS_PER_SEC/.
+<tag/Limits/<itemize>
+<item>Since the machines, cc65 generated programs run on, cannot run multiple
+processes, the function will actually return the time since some
+implementation defined point in the past.
+</itemize>
+<tag/Availability/ISO 9899
+<tag/See also/
+<ref id="time" name="time">
+<tag/Example/None.
+</descrip>
+</quote>
+
+
 <sect1>clrscr<label id="clrscr"><p>
 
 <quote>
@@ -6258,6 +6282,8 @@ only be used in presence of a prototype.
 returned value may not be valid.
 </itemize>
 <tag/Availability/ISO 9899
+<tag/See also/
+<ref id="clock" name="clock">
 <tag/Example/None.
 </descrip>
 </quote>