[Scummvm-cvs-logs] SF.net SVN: scummvm:[49609] tools/branches/gsoc2010-decompiler/decompiler/ doc

[pidgeot at users.sourceforge.net]

Revision: 49609
          http://scummvm.svn.sourceforge.net/scummvm/?rev=49609&view=rev
Author:   pidgeot
Date:     2010-06-12 20:00:45 +0000 (Sat, 12 Jun 2010)

Log Message:
-----------
Update documentation with new member in Disassembler
Add hyperref package to make TOC clickable in PDF

Modified Paths:
--------------
    tools/branches/gsoc2010-decompiler/decompiler/doc/disassembler.tex
    tools/branches/gsoc2010-decompiler/decompiler/doc/preamble.tex

Modified: tools/branches/gsoc2010-decompiler/decompiler/doc/disassembler.tex
===================================================================
--- tools/branches/gsoc2010-decompiler/decompiler/doc/disassembler.tex	2010-06-12 19:56:44 UTC (rev 49608)
+++ tools/branches/gsoc2010-decompiler/decompiler/doc/disassembler.tex	2010-06-12 20:00:45 UTC (rev 49609)
@@ -56,6 +56,7 @@
 	Common::File _f;
 	std::vector<Instruction> _insts;
 	uint32 _addressBase;
+	bool _disassemblyDone;
 
 	virtual void doDisassemble() = 0;
 	virtual void doDumpDisassembly(std::ostream &output);
@@ -77,6 +78,8 @@
 
 \verb+_addressBase+ is provided as a convenience if your engine does not consider the first instruction to be located at address 0. Assign the expected base address to this field, and make sure that the addresses you assign to the instructions are relative to this base address. This is mainly useful if your engine supports jumps or other references to absolute addresses in the script; if only relative addresses are used, the base address will not be relevant.
 
+\verb+_disassemblyDone+ is used to represent whether or not disassembly has already been performed. This is set automatically by \verb+disassemble+ and  \verb+dumpDisassembly+.
+
 \verb+doDisassemble+ is the method used to perform the actual disassembly, so this method must be implemented by all disassemblers.
 
 \verb+disassemble+ simply calls the \verb+doDisassemble+ method to perform the disassembly (if necessary), and returns \verb+_insts+ to the calling methtod.

Modified: tools/branches/gsoc2010-decompiler/decompiler/doc/preamble.tex
===================================================================
--- tools/branches/gsoc2010-decompiler/decompiler/doc/preamble.tex	2010-06-12 19:56:44 UTC (rev 49608)
+++ tools/branches/gsoc2010-decompiler/decompiler/doc/preamble.tex	2010-06-12 20:00:45 UTC (rev 49609)
@@ -44,6 +44,7 @@
 %\labelformat{equation}{(#1)}	% Correct equation references !!DOESN'T WORK ATM!!
 \usepackage{verbatim}
 \usepackage{url}
+\usepackage{hyperref}
 %% Define a new 'leo' style for the package that will use a smaller font.
 \makeatletter
 \def\url at leostyle{%


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.