[Scummvm-cvs-logs] SF.net SVN: scummvm: [20690] web/trunk
sev at users.sourceforge.net
sev at users.sourceforge.net
Tue Feb 14 05:10:03 CET 2006
Revision: 20690
Author: sev
Date: 2006-02-14 05:08:26 -0800 (Tue, 14 Feb 2006)
ViewCVS: http://svn.sourceforge.net/scummvm?rev=20690&view=rev
Log Message:
-----------
2 documents were moved to Wiki.
Add links to Documentation on Wiki as well as Developers Central.
Modified Paths:
--------------
web/trunk/documentation.php
Removed Paths:
-------------
web/trunk/docs/conventions.xml
web/trunk/docs/maccd-howto.xml
Deleted: web/trunk/docs/conventions.xml
===================================================================
--- web/trunk/docs/conventions.xml 2006-02-14 10:11:15 UTC (rev 20689)
+++ web/trunk/docs/conventions.xml 2006-02-14 13:08:26 UTC (rev 20690)
@@ -1,129 +0,0 @@
-<NAME>ScummVM code formatting conventions</NAME>
-<DESC>This page describes the coding style we use in ScummVM.</DESC>
-<BODY>
- <h2>1. Use common sense</h2>
- <p>
- These are conventions which we try to follow when writing code for ScummVM.
- They are this way mainly for reasons of taste, however, sticking to a common
- set of formatting rules also makes it slightly easier to read through our sources.
- If you want to submit patches, please try to follow these rules.
- </p>
- <p>
- As such we don't follow these rules slavishly, in certain cases it is OK (and
- in fact favorable) to stray from them.
- </p>
-
- <h2>2. Hugging braces</h2>
- <p>Braces in your code should look like the following example:</p>
-
- <pre>
- if (int i = 0; i < t; i++) {
- [...]
- } else {
- [...]
- }
-
- class Dummy() {
- [...]
- }
- </pre>
-
- <p>Did you see the {}'s on that?</p>
-
- <h2>3. Tab indents, with tabstop at four spaces</h2>
- Says it all, really.
-
- <h2>4. Whitespaces</h2>
-
- <ol style="list-style: none;">
- <li><h3>Conventional operators surrounded by a space character</h3>
- <pre>
- a = (b + c) * d;
- </pre>
-
- <li><h3>C++ reserved words separated from opening parentheses by a white space</h3>
- <pre>
- while (true) {
- </pre>
-
- <li><h3>Commas followed by a white space</h3>
- <pre>
- someFunction(a, b, c);
- int d, e;
- </pre>
-
- <li><h3>Semicolons followed by a space character, if there is more on line</h3>
- <pre>
- for (int a = 0; b++; c < d)
- doSomething(e); doSomething(f); // This is probably bad style anyway
- </pre>
-
- <li><h3>When declaring class inheritance and in a <tt>?</tt> construct, colons should be surrounded by white space</h3>
- <pre>
- class BusWheel : public RubberInflatable {
- (isNight) ? colorMeDark() : colorMeBright();
- </pre>
-
- <li><h3>Indentation level is not increased after namespace clause</h3>
- <pre>
- namespace Scumm {
-
- byte Actor::kInvalidBox = 0;
-
- void Actor::initActorClass(ScummEngine *scumm) {
- _vm = scumm;
- }
-
- } // End of namespace Scumm
-
- </pre>
- </ol>
-
- <h2>5. Switch / Case constructs</h2>
- <pre>
- switch (cmd) {
- case kSaveCmd:
- save();
- break;
- case kLoadCmd:
- case kPlayCmd:
- close();
- break;
- default:
- Dialog::handleCommand(sender, cmd, data);
- }
- </pre>
-
-
- <h2>6. Naming</h2>
- <ol style="list-style: none;">
- <li><h3>Constants</h3><br>
- Basically, you have two choices:
- <pre>
- kSomeKludgyConstantName // notice k prefix
- </pre>
- or
- <pre>
- SOME_KLUDGY_CONSTANT_NAME
- </pre>
-
- <li><h3>Classes</h3><br>
- Mixed case starting with upper case
- <pre>
- class MeClass() {
- </pre>
-
- <li><h3>Class members</h3><br>
- _ prefixed and in mixed case (Yo! no underscore separators), starting with lowercase.
- <pre>
- char *_someVariableName;
- </pre>
-
- <li><h3>Class methods</h3><br>
- mixed case, starting with lowercase.
- <pre>
- void thisIsMyFancyMethod();
- </pre>
- </ol>
-
-</BODY>
Deleted: web/trunk/docs/maccd-howto.xml
===================================================================
--- web/trunk/docs/maccd-howto.xml 2006-02-14 10:11:15 UTC (rev 20689)
+++ web/trunk/docs/maccd-howto.xml 2006-02-14 13:08:26 UTC (rev 20690)
@@ -1,87 +0,0 @@
-<NAME>Mac CD ScummVM HOWTO</NAME>
-<DESC>This page describes how to copy files from Mac LEC game releases and prepare them for ScummVM.</DESC>
-<BODY>
-
-<h2>Introduction:</h2>
-
-<p>This is a rough description of how to use your Macintosh CD
-version of a classic LucasArts game with ScummVM on Win32. Following
-procedure describes how to do it with "Sam & Max Hit the Road
-Macintosh CD-ROM" on Windows 2000 Professional. Your mileage may
-vary with other titles or versions of Windows.</p>
-
-<h2>Tools:</h2>
-
-<p>You will need the "Windows Installer" from the
-<a href="http://scummvm.sourceforge.net/downloads.php">download page</a>.
-If you're using ScummVM version prior to 0.7.0 you additionally will need
-"ScummVM Tools Windows Installer" from same URL.
-To copy the game data file from the CD to your hard disc, you will
-need
-<a href="http://gamma.nic.fi/~lpesonen/HFVExplorer/">HFVExplorer</a>. Make
-sure you get the "HFV Explorer installer" rather than the zip
-file.</p>
-
-<p>You should be running as Administrator to install all of the
-tools. Everything else should work as a normal user. Run the
-ScummVM installers and allow them to install to the default
-location (C:\ScummVM). Don't worry about overwriting files. Run the
-HFVExplorer installer and allow it to use its defaults.</p>
-
-<h2>Copying the game data file:</h2>
-
-<p>Start up HFVExplorer; if you don't have a shortcut for it, find
-it in "c:\program files\HFVExplorer". It should open the HFS
-(Macintosh filesystem) CD-ROM automatically when you insert the
-disc. Make sure HFVExplorer is displaying hidden files: Select
-View->Options and enable "Show invisible Mac files" on the "File
-attributes" tab.</p>
-
-<p>Now, look for the data file in the right pane. It will probably
-end with the word "Data" and will be the largest file on the
-volume. For instance, it is called "Sam & Max Data" on the "Sam
-& Max" CD-ROM. Select the data file and copy it (use Ctrl+C or
-Edit->Copy). In the left HFVExplorer pane, navigate to the
-directory where you want the game to reside on your hard disc. We
-recommend selecting drive C: and creating a new folder called
-"SamNMax" or a name that better reflects your particular game.</p>
-
-<p>Paste the data file (with Ctrl+V or Edit->Paste) and allow
-HFVExplorer to choose the copy mode. Now, wait while the program
-copies several hundred megabytes from the CD. When the file is
-copied, close HFVExplorer.</p>
-
-<h2>Running rescumm:</h2>
-
-<p><b>NOTE:</b> If you are using ScummVM version 0.7.0 and
-above, you don't need this. Just point ScummVM to folder where
-you copied the Data file. <small>(Hint: If you're using older
-version we strongly recommend to upgrade)</small></p>
-
-<p>Open a command prompt window and change the directory to your
-newly created folder. Then, run rescumm on the data file to extract
-its contents. For example, type the following for Sam & Max,
-making sure you use double quotes around the data filename:</p>
-<pre>
-cd c:\SamNMax
-c:\scummvm\rescumm "Sam & Max Data"
-
-</pre>
-
-<p>Once the several files are successfully extracted, you can
-delete the data file. Now, you can fire up ScummVM and add the new
-game to play it. The ScummVM documentation (README) describes
-ScummVM and rescumm usage in detail. If you have any questions,
-look at the <a href="/faq.php">ScummVM FAQ</a>,
-the <a href="/documentation.php">ScummVM Documentation</a>, and the
-<a href="http://sourceforge.net/forum/?group_id=37116">forums</a>.</p>
-
-<h2>Related Information:</h2>
-
-<p>If you are using ScummVM on MacOS X, you may find
-<a href="http://www.ps2cheats.com/randomstuff/scumm/">How to Rescumm for Dummies!</a> useful.</p>
-<p><br />
-<br />
-Based on document Copyright © 2004 Jonathan Rogers</p>
-
-</BODY>
\ No newline at end of file
Modified: web/trunk/documentation.php
===================================================================
--- web/trunk/documentation.php 2006-02-14 10:11:15 UTC (rev 20689)
+++ web/trunk/documentation.php 2006-02-14 13:08:26 UTC (rev 20690)
@@ -46,6 +46,12 @@
<a href='http://svn.sourceforge.net/viewcvs.py/*checkout*/scummvm/scummvm/tags/release-0-8-2/README'>README 0.8.2</a><br />
The ScummVM README, for version 0.8.2<br /><br />
+
+ <a href='http://wiki.scummvm.org/index.php/Documentation'>Documentation on Wiki</a><br />
+ Assorted documentation on our Wiki<br /><br />
+
+ <a href='http://wiki.scummvm.org/index.php/Developer_Central'>Developer Central</a><br />
+ Guidelines on how to hack ScummVM. A must read for developers.<br /><br />
<?php
More information about the Scummvm-git-logs
mailing list