]> git.sur5r.net Git - cc65/commitdiff
Moved documentation to funcref.
authorIrgendwerA8 <c.krueger.b@web.de>
Thu, 21 Mar 2019 20:04:24 +0000 (21:04 +0100)
committerOliver Schmidt <ol.sc@web.de>
Fri, 29 Mar 2019 21:53:04 +0000 (22:53 +0100)
doc/funcref.sgml
doc/index.sgml
doc/specialmath.sgml [deleted file]

index bfd687b6f2217adfaad10009d15a2a62646c0616..f995d29821ce5ea301a770248b5df3c97a8b35b6 100644 (file)
@@ -578,6 +578,12 @@ communication, see also <tt>testcode/lib/ser-test.c</tt>.
 <item><ref id="signal" name="signal">
 </itemize>
 
+<sect1><tt/specialmath.h/<label id="specialmath.h"><p>
+
+<itemize>
+<item><ref id="_mul20" name="_mul20">
+<item><ref id="_mul40" name="_mul40">
+</itemize>
 
 <sect1><tt/stdarg.h/<label id="stdarg.h"><p>
 
@@ -1020,6 +1026,29 @@ It returns 1 if it does.
 </descrip>
 </quote>
 
+<sect1>_mul20<label id="_mul20"><p>
+
+<quote>
+<descrip>
+<tag/Function/Multiplies argument by 20.
+<tag/Header/<tt/<ref id="specialmath.h" name="specialmath.h">/
+<tag/Declaration/<tt/unsigned int __fastcall__ _mul20(unsigned char value);/
+<tag/Description/Speed optimized function to multiply an 8 bit unsigned value by 20 to get a 16 bit result.
+<tag/Availability/cc65
+</descrip>
+</quote>
+
+<sect1>_mul40<label id="_mul40"><p>
+
+<quote>
+<descrip>
+<tag/Function/Multiplies argument by 40.
+<tag/Header/<tt/<ref id="specialmath.h" name="specialmath.h">/
+<tag/Declaration/<tt/unsigned int __fastcall__ _mul40(unsigned char value);/
+<tag/Description/Speed optimized function to multiply an 8 bit unsigned value by 40 to get a 16 bit result.
+<tag/Availability/cc65
+</descrip>
+</quote>
 
 <sect1>_poserror<label id="_poserror"><p>
 
index 55e69f40f74a2441f032f7081e15ee51af305cc3..aecfb7de992f9f12e30270f264f606983818a5bc 100644 (file)
@@ -97,9 +97,6 @@
   Describes Christian Kr&uuml;ger's macro package for writing self modifying
   assembler code.
 
-  <tag><htmlurl url="specialmath.html" name="specialmath.html"></tag>
-  Library for speed optimized math functions.  
-
   <tag><url name="6502 Binary Relocation Format document"
         url="http://www.6502.org/users/andre/o65/fileformat.html"></tag>
   Describes the o65 file format that is used for dynamically loadable modules
diff --git a/doc/specialmath.sgml b/doc/specialmath.sgml
deleted file mode 100644 (file)
index 5e2fd90..0000000
+++ /dev/null
@@ -1,38 +0,0 @@
-<!doctype linuxdoc system>
-
-<article>
-<title>Special math functions
-<author>Christian Kr&uuml;ger
-
-<abstract>
-This library provides functions for speed optimized math operations.
-</abstract>
-
-<!-- Table of contents -->
-<toc>
-
-<!-- Begin the document -->
-
-<sect>Multiplication<p>
-
-When accessing screen memory often a multiplication of the vertical position is needed to calculate
-the target address. A quite common horizontal span for 8-bit systems is 20 or 40 bytes (beside e.g. 32 bytes, where the multiplication can be accomplished by shifting 5 times).
-
-<p>
-<tscreen><verb>
-    unsigned int __fastcall__ _mul20(unsigned char value);
-</verb></tscreen>
-
-The 8 bit <tt>value</tt> is multiplied by 20 and returned as 16 bit value.
-</p>
-
-<p>
-<tscreen><verb>
-    unsigned int __fastcall__ _mul40(unsigned char value);
-</verb></tscreen>
-
-The 8 bit <tt>value</tt> is multiplied by 40 and returned as 16 bit value.
-</p>
-
-
-</article>